Primeira chamada

objetivo desta página sair do zero e receber uma resposta do erp sem sdk, sem instalar nada o que você precisa ter em mãos item quem fornece endereço do erp o órgão chave de integração o órgão, na tela administração → chaves de integração identificador do órgão (tenant) o órgão, na mesma conversa a chave é mostrada uma única vez a quem a emite se ela se perdeu, não há recuperação peça outra e a antiga é revogada passo 1 — prove a credencial comece pelo health é o único endereço que responde a qualquer chave válida, independentemente do escopo ele existe exatamente para separar "minha chave está errada" de "minha chave não pode isso" curl i h "x erp appkey $erp app key" \\ h "x tenant id $erp tenant id" \\ https //erp exemplo gov br/api/v1/integration/health 200 com {"status" "ok"} significa que a chave é válida e o órgão foi resolvido qualquer outra coisa aqui é problema de credencial, não de permissão os dois cabeçalhos vão em toda requisição não há login, troca de token nem sessão passo 2 — busque um dado agora uma chamada real este exemplo exige read asset report no escopo da chave curl h "x erp appkey $erp app key" \\ h "x tenant id $erp tenant id" \\ "https //erp exemplo gov br/api/asset/assets/disposals/search" não escolha o endereço por intuição boa parte das leituras ainda não declara a permissão que exige e, por isso, está fechada para chave de integração — o catálogo abre com o número e marca cada uma escolha do catálogo um endereço cuja coluna escopo exigido esteja preenchida, e peça esse escopo ao órgão leia o que voltou resposta significado o que fazer 200 funcionou seguir 401 a chave apresentada não é reconhecida — errada, expirada no cadastro, ou revogada conferir o valor com o órgão; repetir não resolve 403 a chave é válida, mas não pode essa operação ver autenticação e permissões docid\ uursmhcjyymfej0bzqpkd 404 o caminho não existe conferir no catálogo de operações docid 825w6ivxqiy 5f88z8ubi 429 limite de chamadas da chave estourado respeitar o retry after a distinção entre 401 e 403 é a informação mais útil desta página 401 é sobre quem você é o cabeçalho foi apresentado e não casou com nenhuma chave ativa 403 é sobre o que você pode a chave é boa e o escopo dela não cobre a operação repetir não resolve nenhum dos dois, mas a ação é diferente — no primeiro você fala de credencial com o órgão, no segundo você fala de escopo requisição sem cabeçalho nenhum é caso à parte aí não há credencial para reconhecer, e a cadeia de segurança responde 403 por não haver autenticação se você recebeu 403 logo na primeira tentativa, confira antes de tudo se os dois cabeçalhos estão realmente sendo enviados descobrir o que mais dá para chamar duas formas, e as duas exigem a chave o catálogo , offline e versionado — catálogo de operações docid 825w6ivxqiy 5f88z8ubi toda operação, com verbo, caminho e o escopo que ela exige o documento openapi da área , contra um ambiente no ar — servido em /v3/api docs/{área} e protegido pela mesma chave das chamadas curl h "x erp appkey $erp app key" \\ h "x tenant id $erp tenant id" \\ https //erp exemplo gov br/v3/api docs/finance o finance json os dois cabeçalhos, sempre a chave é conferida dentro do schema do seu tenant , então sem x tenant id a consulta cai no schema de plataforma, onde a tabela de chaves não existe — e a resposta é 401, indistinguível de chave errada vale para o contrato como vale para qualquer chamada baixado, ele abre em qualquer visualizador de openapi as doze áreas estão em convenções da api docid 01del2y3g0otviq5mneyt o console interativo (/swagger ui/index html) existe, mas não é você quem o abre a página é servida atrás da mesma proteção do contrato, e um navegador não envia cabeçalho ao navegar — então nem a tela de login do authorize chega a carregar; a resposta é 401 antes disso quem destrava é o responsável pelo sistema no órgão , na tela de chaves do portal ele cola a chave uma vez e o navegador dele recebe um acesso de curta duração na prática isto significa para trabalhar sozinho, use o curl acima e o catálogo peça o console ao órgão quando precisar experimentar chamadas com alguém do lado deles junto — que costuma ser o momento em que o console vale mais próximo passo se você vai escrever em typescript, pule o curl e vá para kit de desenvolvimento (sdk typescript) docid xup025aoj effhbdffce o kit já monta os cabeçalhos e devolve objetos tipados