Documentação de API
Esta é a documentação para os endpoints de API disponíveis, que são construídos em torno da **arquitetura REST**. Todos os endpoints da API retornarão uma **resposta JSON** com os **códigos de resposta HTTP padrão** e precisam de **Autenticação Bearer via uma Chave API**.
Autenticação
Todos os endpoints da API exigem uma chave de API enviada pelo método de **Autenticação Bearer**.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://vcard.spaceboox.com.br/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://vcard.spaceboox.com.br/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Erros
Nossa API usa códigos de status HTTP convencionais para indicar o sucesso ou falha da solicitação.
{
"errors": [
{
"title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
"status": 401
}
]
}
200 Solicitação concluída com sucesso
400 Solicitação inválida - parâmetros obrigatórios ausentes ou inválidos
401 Não autorizado - chave de API ausente ou inválida
404 O recurso solicitado não foi encontrado
429 Solicitações em excesso - limite de taxa excedido
500 Erro interno do servidor - significa que há um problema do nosso lado
Todos os resultados dos endpoints da API utilizam o fuso horário UTC, salvo indicação em contrário.
Usuário
Cartões Digitais
Estatísticas SpaceBoox
Pixels
Domínios personalizados
Registros de conta