Uma API REST JSON para estatísticas, avaliações, classificações e telefone

Os dados por trás da Astrina — análises do site, avaliações, resumos de classificações e inteligência de telefone — agora estão disponíveis para serem puxados diretamente para o seu próprio código. A API para desenvolvedores é uma API REST JSON que fornece tudo de volta a partir de uma única chave.

Uma chave, quatro endpoints

A API é versionada sob /api/v1 e cada endpoint fala JSON simples. Aponte seu cliente para o recurso que você precisa:

• GET /api/v1/stats — análises para um site que você possui: visitantes, visualizações de página, páginas principais, fontes e países.
• GET /api/v1/reviews — avaliações mais a classificação para um assunto.
• GET /api/v1/rating — um resumo de classificação com a distribuição de estrelas.
• GET /api/v1/phone — inteligência de telefone.

Além disso, a API de autenticação alimenta "Login com Astrina", para que você possa adicionar o login social ao seu próprio aplicativo sem precisar construir uma pilha de identidade você mesmo.

Autentique da maneira que se encaixa na sua pilha

Pegue uma chave de /my/api.php, então envie-a da maneira mais limpa para o seu cliente. A API aceita três formas:

• Um X-Api-Key cabeçalho.
• Um Authorization: Bearer token.
• Um ?api_key= parâmetro de consulta.

A autenticação baseada em cabeçalho é o padrão mais seguro para código do lado do servidor; o parâmetro de consulta é útil para testes rápidos e chamadas do lado do navegador. As respostas são abertas ao CORS, então você pode chamar a API diretamente do front end quando isso for conveniente, e elas são marcadas noindex para que seus dados não vazem para motores de busca.

Cotas e planos

O uso é medido por dia, e cada resposta informa onde você está — cada carga útil inclui o uso da sua cota, para que você nunca precise adivinhar quantas chamadas ainda tem.

• Camada gratuita: 100 chamadas por dia.
• Plano da API: 10.000 chamadas por dia por €19 a cada 30 dias.
• Camada de análises de negócios:O acesso à API está incluído.

Comece com o gratuito para prototipar, depois avance quando sua integração precisar de mais espaço.

JSON previsível, erros previsíveis

O sucesso e a falha retornam ambos como JSON. Quando algo dá errado, a resposta traz um error campo e o status HTTP correto, para que seu tratamento de erros possa ramificar com base no código de status em vez de analisar strings:

• 401 — chave inválida.
• 429 — cota excedida.
• 400 / 422 — parâmetros inválidos.

Como o estado da cota é enviado em cada resposta, um cliente bem-comportado pode recuar antes de ver um 429.

Como começar

1. Abra /my/api.php e crie uma chave de API.
2. Escolha um endpoint — comece com /api/v1/stats para um site que você possui.
3. Envie sua chave no cabeçalho X-Api-Key e leia o JSON de volta.

Uma primeira chamada é uma linha:

curl -H "X-Api-Key: YOUR_KEY" https://astrina.io/api/v1/stats

Prefere um token de portador? Troque o cabeçalho:

curl -H "Authorization: Bearer YOUR_KEY" https://astrina.io/api/v1/reviews

Ou coloque a chave diretamente na URL para uma verificação rápida:

curl "https://astrina.io/api/v1/rating?api_key=YOUR_KEY"

A partir daí, o mesmo padrão cobre classificações e inteligência de telefone — uma chave, um cabeçalho, quatro fontes de dados. Obtenha sua chave e faça sua primeira chamada hoje.