Guia

Comece em 5 minutos

Crie a chave e faça a primeira chamada.

1. Crie a chave

Na plataforma, como Proprietário da Conta, abra Configurações → Integrações e crie uma chave. Dê um nome que diga onde ela vai morar (por exemplo, “ERP da matriz”) e marque só os escopos de que a integração precisa. A chave completa começa com fs_live_ e aparece uma vez.

2. Faça a primeira chamada

curl

export FROTASIMPLES_CHAVE=fs_live_...

curl https://frotasimples.com/api/v1/conta \
  -H "Authorization: Bearer $FROTASIMPLES_CHAVE"

Node.js (18+)

const resposta = await fetch('https://frotasimples.com/api/v1/conta', {
  headers: { Authorization: `Bearer ${process.env.FROTASIMPLES_CHAVE}` },
})
if (!resposta.ok) throw new Error((await resposta.json()).detail)
console.log(await resposta.json())

Python

import os
import requests

resposta = requests.get(
    "https://frotasimples.com/api/v1/conta",
    headers={"Authorization": f"Bearer {os.environ['FROTASIMPLES_CHAVE']}"},
    timeout=30,
)
resposta.raise_for_status()
print(resposta.json())

PHP

<?php
$ch = curl_init('https://frotasimples.com/api/v1/conta');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('FROTASIMPLES_CHAVE')],
]);
$conta = json_decode(curl_exec($ch), true);

3. Confira a resposta

Um 200 com a Conta, o plano e os escopos da chave confirma que está tudo certo. Um 401 indica chave errada ou revogada; um 403 com plano_sem_api, que o plano da Conta não inclui a API. Veja todos os códigos em Erros.

Próximos passos

Navegue pelas operações na referência.
Leia sobre paginação antes de importar listas grandes.
Para escrever, leia idempotência.
Para receber mudanças sem consultar, configure um webhook.

2. Faça a primeira chamada

curl

export FROTASIMPLES_CHAVE=fs_live_...

curl https://frotasimples.com/api/v1/conta \
  -H "Authorization: Bearer $FROTASIMPLES_CHAVE"

Node.js (18+)

const resposta = await fetch('https://frotasimples.com/api/v1/conta', {
  headers: { Authorization: `Bearer ${process.env.FROTASIMPLES_CHAVE}` },
})
if (!resposta.ok) throw new Error((await resposta.json()).detail)
console.log(await resposta.json())

Python

import os
import requests

resposta = requests.get(
    "https://frotasimples.com/api/v1/conta",
    headers={"Authorization": f"Bearer {os.environ['FROTASIMPLES_CHAVE']}"},
    timeout=30,
)
resposta.raise_for_status()
print(resposta.json())

PHP

<?php
$ch = curl_init('https://frotasimples.com/api/v1/conta');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('FROTASIMPLES_CHAVE')],
]);
$conta = json_decode(curl_exec($ch), true);