IntegraçõesAPI
Uma chamada depois da marcação ou da encomenda, e Citypicked pede a avaliação. As avaliações e o feedback privado voltam como webhooks.
Pedido
POST /v1/requests Authorization: Bearer cp_live_… Idempotency-Key: booking-4711 { "channel": "sms", "consent": true, "contacts": [{ "name": "Inês Claro", "phone": "+12015550123" }] }
Resposta 201
{ "created": 1,
"results": [{ "outcome": "created", "request_id": "…" }] }Webhooks
Subscreve um URL aos eventos de que precisas. Cada entrega é assinada e chega em segundos.
Verificar a assinatura
Citypicked-Signature: t=1762594200,v1=5f2c… const expected = crypto .createHmac("sha256", secret) .update(`${t}.${rawBody}`) .digest("hex");
Se o teu URL não responder com um 2xx, tentamos mais seis vezes ao longo de cerca de 18 horas.
Endpoints
Ler funciona com qualquer chave. Para enviar, é preciso uma chave com permissão de envio.
Antes da primeira chamada
Nada a mais. Ler funciona em todos os planos, enviar através da API a partir do Pro. As SMS gastam créditos, tal como na app, os e-mails não.
Sim. Com send_at agendas com até 30 dias de antecedência. Até lá, basta uma chamada para o cancelar, por exemplo quando uma marcação não se realiza.
Não. Também podes ir buscar pedidos e feedback, com since para obter só o que é novo. Os webhooks poupam-te as consultas repetidas e chegam logo.
Com channel definido como whatsapp, recebes um link de volta. A equipa abre-o no próprio telemóvel e envia ela mesma a mensagem, tal como na app.
Sim, a descrição OpenAPI 3.1 de todos os endpoints, disponível sem chave.
O teu primeiro pedido sai em cinco minutos.