Início rápido

Conecte-se à Listings API, liste seus locais, crie um local e responda a uma avaliação em TypeScript.

1. Configure sua chave de API

Obtenha sua chave em Chaves de API → Nova chave no painel de desenvolvedor da Listings API.

bash

export LISTINGSAPI_KEY="your-api-key"

new ListingsAPI() lê LISTINGSAPI_KEY do ambiente automaticamente, ou você pode passar apiKey explicitamente.

2. Liste seus locais

quickstart.ts

import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI(); const result = await client.fetchAllLocations({ first: 5 });if (!Array.isArray(result)) {for (const location of result.locations) {  console.log(location.name, '--', location.city, location.stateIso);}console.log('\nhasNextPage:', result.pageInfo.hasNextPage);}

bash

npx tsx quickstart.ts

Saída esperada:

bash

Acme Dental Midtown -- New York NYAcme Dental Brooklyn -- Brooklyn NYAcme Dental Jersey City -- Jersey City NJ hasNextPage: false

fetchAllLocations retorna um objeto com locations e pageInfo por padrão. Passe fetchAll: true para que o SDK percorra automaticamente as páginas usando cursores e retorne Location[] sem aninhamento.

TypeScript

const all = await client.fetchAllLocations({ fetchAll: true, pageSize: 100 });if (Array.isArray(all)) {console.log('Total: ' + all.length + ' locations');}

3. Crie um local

A API exige name, city, countryIso, subCategoryId e um valor de description com pelo menos 200 caracteres. Obtenha valores válidos de subCategoryId em client.fetchSubcategories() e use o databaseId de cada entrada.

TypeScript

const created = await client.createLocation({name: 'Acme Dental',storeId: 'ACME-NYC-001',street: '123 Jump Street',city: 'New York',stateIso: 'NY',postalCode: '10013',countryIso: 'US',phone: '6443859313',subCategoryId: 1432,description:  'Acme Dental is a family-owned dental practice serving downtown New York since 2009. ' +  'Our team provides preventive checkups, cosmetic dentistry, orthodontics, and emergency care, ' +  'with same-day appointments, transparent pricing, and a patient-first approach on every visit.',});console.log(created);

Se o payload for inválido, o SDK lança uma exceção ValidationError que contém as entradas de erro da plataforma, mesmo quando a API retorna HTTP 200. Não há uma flag success para verificar.

4. Responda a uma avaliação

Busque as avaliações de um local e responda usando o ID da interação. IDs numéricos de locais são aceitos em todas as operações: o SDK os codifica em base64 automaticamente.

TypeScript

const reviews = await client.fetchInteractions(16808, {startDate: '2026-01-01',endDate:   '2026-06-30',first: 10,}); if (!Array.isArray(reviews)) {const unanswered = reviews.interactions.find(  (review) => (review.responses ?? []).length === 0,);if (unanswered) {  console.log(unanswered.rating, unanswered.content?.slice(0, 80));  await client.respondToReview(    unanswered.id,    'Thank you for the kind words! We look forward to seeing you at your next visit.',  );}}

5. Trate erros

TypeScript

import { ListingsAPI, APIError, AuthenticationError } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'bad-key' }); try {await client.fetchAllLocations();} catch (error) {if (error instanceof AuthenticationError) {  console.log('Invalid API key. Check LISTINGSAPI_KEY.');} else if (error instanceof APIError) {  console.log('Status:', error.statusCode);  // can be 200 for payload-level errors  console.log('Code:',   error.code);        // first platform code, e.g. 'SY10005'  console.log('Errors:', error.errors);      // [{ code, message, context }, ...]}}

O SDK lança erros tipados para respostas fora da faixa 2xx, para payloads de erro que a plataforma retorna com HTTP 200 e para operações de escrita que informam success: false. Ele também faz novas tentativas automaticamente ao receber respostas 429 e 5xx. Consulte Tratamento de erros para conhecer padrões de novas tentativas e orientações sobre códigos de status.

Próximos passos

Configuração: substituição da URL base e configuração de projetos TypeScript
Casos de uso: 10 exemplos completos
Locais: criar, atualizar, pesquisar, arquivar