Início rápido

1. Crie uma chave de teste

1. No painel do Urdume, abra Programadores e crie uma chave em modo Teste (começa por sk_test_).
2. Copie-a: o valor completo só é mostrado uma vez.
3. Guarde-a no servidor como variável de ambiente, por exemplo URDUME_KEY. Nunca a coloque em código que corre no browser.

2. Primeiro pedido

Confirme que a chave funciona e veja o identificador público da sua empresa (usado nos endereços /r/… e no widget).

curl https://urdume.site/api/v1/account \
  -H "Authorization: Bearer $URDUME_KEY"

<?php
$ch = curl_init('https://urdume.site/api/v1/account');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('URDUME_KEY')],
]);
$account = json_decode(curl_exec($ch), true);
echo $account['handle']; // o identificador público da sua empresa

// Node 18+ (fetch incluído)
const response = await fetch('https://urdume.site/api/v1/account', {
  headers: { Authorization: `Bearer ${process.env.URDUME_KEY}` },
});
const account = await response.json();
console.log(account.handle);

import os, requests

account = requests.get(
    "https://urdume.site/api/v1/account",
    headers={"Authorization": f"Bearer {os.environ['URDUME_KEY']}"},
    timeout=10,
).json()
print(account["handle"])

Resposta

{
  "object": "account",
  "name": "A Sua Marca, Lda.",
  "handle": "a-sua-marca",
  "reference_url": "https://urdume.site/r/a-sua-marca/",
  "livemode": false
}

3. Crie um produto

Os campos de "data" são os do modelo têxtil (GET /templates mostra-os todos, com o tipo e se são obrigatórios). A referência é a sua: é por ela que o produto se encontra depois.

POST /products

curl https://urdume.site/api/v1/products \
  -H "Authorization: Bearer $URDUME_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "T-shirt básica",
    "reference": "TS-100",
    "data": {
      "article_type": "top",
      "brand": "A Sua Marca",
      "fibre_composition": [{"fibre": "cotton", "percent": 100}],
      "country_making": "PT"
    }
  }'

4. Emita o passaporte

Com os campos obrigatórios preenchidos, emita o passaporte. Em "url" fica a página pública (o destino do QR Code).

POST /passports

curl https://urdume.site/api/v1/passports \
  -H "Authorization: Bearer $URDUME_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product": "01J9C…"}'

{
  "id": "01J9D…",
  "object": "passport",
  "livemode": false,
  "status": "active",
  "url": "https://urdume.site/p/01J9D…",
  ...
}

5. Próximos passos

• Sessões alojadas: a sua equipa cria o passaporte numa página do Urdume, como no Stripe Checkout.
• Webhooks: receba no seu servidor os avisos de passaportes emitidos e sessões concluídas.
• Widget para lojas: mostre o passaporte na página do produto com duas linhas de HTML.
• Produção: o que verificar antes de usar chaves sk_live_.