Primeiros passos
Crie sua conta, adicione uma forma de pagamento, obtenha sua chave de API e faça sua primeira chamada à Listings API.
Este guia explica como criar uma conta, obter sua primeira chave de API e fazer uma requisição à Listings API.
1. Crie sua conta
Escolha um plano na página de preços para abrir o formulário de cadastro e informe seu nome, sobrenome, e-mail profissional e empresa. Você já tem uma conta? Nesse caso, entre.
2. Adicione uma forma de pagamento
Depois que você enviar o formulário, redirecionamos você ao nosso provedor de pagamentos para adicionar um cartão. Seu teste gratuito começa imediatamente e é convertido no plano escolhido quando o teste termina, então cancele antes disso se não quiser receber uma cobrança. As perguntas frequentes sobre preços informam a duração atual do teste e os limites dos planos.
3. Defina sua senha e entre
Após a conclusão do processo de pagamento, enviamos por e-mail um link para você definir sua senha e ativar sua conta. Depois de definir sua senha, entre com seu e-mail e senha ou escolha Email me a sign-in link (enviar um link de login por e-mail) para receber um link de acesso de uso único.
4. Obtenha sua chave de API
Sua primeira chave de API é emitida automaticamente quando sua conta é criada; você pode encontrá-la no painel, em API Keys. Para criar outra, escolha New key (nova chave), dê um nome a ela e selecione seu nível de acesso (Read (leitura) ou Write (escrita)).
5. Faça sua primeira requisição
Autentique cada requisição com um cabeçalho Authorization cujo valor seja a string literal API (observe o espaço no final), seguida da sua chave:
curl https://listingsapi.com/api/v4/locations \ -H "Authorization: API $LISTINGSAPI_KEY"A resposta tem uma estrutura aninhada, em vez de ser apenas um array: os resultados ficam em data.allLocations, cada registro é um edges[].node e pageInfo contém o cursor de paginação e os totais.
{ "data": { "allLocations": { "edges": [ { "cursor": "TG9jYXRpb246MTgwMDI4OQ==", "node": { "id": "TG9jYXRpb246MTgwMDI4OQ==", "databaseId": 1800289, "name": "Jenny Home", "city": "Austin", "stateIso": "TX", "countryIso": "US" } } ], "pageInfo": { "endCursor": "TG9jYXRpb246MTgwMDI4OQ==", "hasNextPage": false, "total": 1 } } }}Para avançar pelas páginas, envie pageInfo.endCursor de volta como ?after=… enquanto pageInfo.hasNextPage for true e pare também se uma página retornar um array edges vazio. Cada edge também contém seu próprio cursor, e o cursor do último edge é o endCursor dessa página, portanto qualquer um dos dois valores funciona como ?after=.
Nem todos os endpoints que retornam listas usam a mesma paginação
A estrutura edges / node / pageInfo acima segue o estilo de paginação por cursor do Relay e é apenas uma das três:
- Paginação por cursor (
first,after→edges[].nodemaispageInfocomendCursor/hasNextPage): locais, busca de locais e endpoints de avaliações (interações por local e o consolidado da conta). - Paginação por offset (
page,perPage→ um arrayrecordsmaispageInfocomtotalRecords,totalPages,hasNextPage,hasPreviousPage): contas conectadas, sugestões de conexão, publicações de um local, publicações em massa de um local e o consolidado de listagens duplicadas de toda a conta. - Arrays simples, sem nenhuma paginação: os endpoints de catálogo (subcategorias, países e estados, sites dos planos) e as fotos de um local.
Confira o exemplo de resposta na página do próprio endpoint antes de escrever um laço de paginação; um laço que usa cursor em um endpoint com paginação por offset lê uma chave edges que nunca está presente.
Próximos passos
- Passe diário do ambiente de testes: experimente locais e listagens sem precisar de cartão. Você ou seu agente de IA pode ativá-lo.
- Autenticação: cabeçalhos de chave de API e rotação de chaves.
- Códigos de erro: códigos de status HTTP e a estrutura da resposta de erro.
- SDKs: clientes tipados para Python e Node.