Skip to main content

Guia de Início

Olá amigo desenvolvedor.

Se você chegou até este link é porque deseja se conectar com a Orbia através de nossas API´s.

Vamos tratar aqui exclusivamente das APIs relacionadas ao envio do XML de notas fiscais para entrar no programa de fidelidade da orbia, ok?

Primeiramente precisamos explicar que a Orbia tem dois ambientes distintos, o ambiente de homologação onde você se conectará para enviar notas neste ambiente e será possível validar esta integração verificando o resultado do envio pelos return code e será possível consultar esta integração no portal do distribuidor ou produtor.

Explicando como funciona e para que servem as integrações:

Distribuidor: Você pode enviar as notas fiscais emitidas pelo seu sistema de faturamento / ERP diretamente para Orbia. É a partir destas notas fiscais que as regras de pontos são verificadas e os produtos participantes geram pontos.

Você deve filtrar no seu sistema as notas emitidas com CFOPs válidos e que atendem a todos os critérios do termo de aceite/regulamento.

CFOPs validos e demais critérios.

Bayer: termo de aceite/regulamento

Yara: termo de aceite/regulamento

Para começar, você precisará de credenciais de acesso para usar as APIs, essas credenciais podem ser solicitadas pelo suporteintegracoes@orbia.ag

O time de TI da Orbia, responsável pela implantação de novos Distribuidores ou ERP de produtor rural irá entrar em contato para fechar um planejamento gerando um cronograma e acompanhar os testes.

A Orbia disponibiliza um conjunto de 5 APIs. Uma delas para checar se seu cadastro está ativo e pronto para enviar e consultar notas, estando tudo ok você pode enviar notas e consultar estas notas verificando seu status ou a quantidade de pontos que estas notas geraram.

Em homologação os endpoints terão em seu nome UAT indicando que é para este ambiente que está mandando as notas. Neste ambiente você precisará do apoio do time de TI da Orbia para consultar no portal do Seller de homologação se as notas foram recebidas corretamente. Isso fará parte de um plano de implantação que fecharemos em conjunto.

Por exemplo:

https://integration-loyalt.orbia.nom.co/prwapi/accrual-invoice/check-seller

Para produção você deverá receber novas credenciais e retirar o “UAT.” do endopint.