Pular para o conteúdo

Registrar/atualizar merchant

Requisição

Host: Keeta. Vincula o ID do merchant no seu sistema ao ID da Keeta e registra suas URLs.

ParâmetroOndeDescrição
merchantIdquery (obrig.)ID do merchant no seu sistema (o mesmo que será enviado em x-polling-merchants)
Campo do corpoTipoObrig.Descrição
keetaMerchantIdnumbersimID gerado pela Keeta (Dev Portal / portal do merchant)
getMerchantURL.baseURLstringsim, quando getMerchantURL é enviadoURL do seu GET /v1/merchant para este merchant
getMerchantURL.apiKeystringnãoChave, se seu endpoint exigir
ordersWebhookURLstringnãoURL do seu webhook POST /v1/newEvent

Importante:

  1. O keetaMerchantId garante o mapeamento correto; guarde a relação entre os dois IDs no seu sistema.
  2. Reenviar um onboarding com um keetaMerchantId ou merchantId já registrado na mesma aplicação apaga o mapeamento anterior e cria um novo.
  3. Sem onboarding, não há eventos de pedido (nem via polling, nem via webhook).

Exemplo: PUT /v1/merchantOnboarding?merchantId=LOJA-SP-001

{
  "keetaMerchantId": 159416882,
  "getMerchantURL": { "baseURL": "https://api.seupdv.com.br/keeta/lojas/LOJA-SP-001/merchant", "apiKey": "chave-da-loja" },
  "ordersWebhookURL": "https://api.seupdv.com.br/keeta/v1/newEvent"
}

Respostas: 201 (devolve o próprio objeto), 400, 401, 403, 404, 503.

Segurança
OAuth2(Escopos obrigatórios: od.all) and Sig
Consulta
merchantIdstringobrigatório

The ID of the Merchant for whom you want to complete or change registration info.

Corpoapplication/jsonobrigatório
getMerchantURLobject

Informações de acesso ao GET /v1/merchant do Software Service do merchant. A Keeta usa este endpoint para obter os dados do merchant.

ordersWebhookURLstring, (uri)

URL do webhook POST /v1/newEvent do Software Service. A Keeta envia os eventos do pedido para este endereço.

keetaMerchantIdnumberobrigatório

ID do merchant na Keeta, gerado pela Keeta e obtido no Merchant Portal.

curl -i -X PUT \
  'https://open.mykeeta.com/api/open/opendelivery/v1/merchantOnboarding?merchantId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-App-Signature: YOUR_API_KEY_HERE' \
  -d '{
    "getMerchantURL": {
      "baseURL": "http://example.com",
      "apiKey": "string"
    },
    "ordersWebhookURL": "http://example.com",
    "keetaMerchantId": 0
  }'

Respostas

Resource has been created.

Corpoapplication/json
getMerchantURLobject

Informações de acesso ao GET /v1/merchant do Software Service do merchant. A Keeta usa este endpoint para obter os dados do merchant.

ordersWebhookURLstring, (uri)

URL do webhook POST /v1/newEvent do Software Service. A Keeta envia os eventos do pedido para este endereço.

keetaMerchantIdnumberobrigatório

ID do merchant na Keeta, gerado pela Keeta e obtido no Merchant Portal.

Resposta
{ "getMerchantURL": { "baseURL": "http://example.com", "apiKey": "string" }, "ordersWebhookURL": "http://example.com", "keetaMerchantId": 0 }