Catálogo de APIs
Documentação da API
Introdução à API
A Cargo Insurance fornece integração perfeita para obter cobertura de seguro de carga on-line. Com esta API, os usuários podem gerenciar e segurar suas remessas com eficiência, garantindo tranquilidade e proteção financeira contra possíveis perdas durante o trânsito. A API é acessada através de uma solicitação POST para duas URLs base, uma para teste e outra para produção que são fornecidas abaixo, e requer autenticação através dos cabeçalhos api_key e api_sec , estes serão fornecidos pelo administrador para você. Esta abordagem simplificada permite um processamento de seguros rápido e seguro, adaptado às necessidades das operações logísticas modernas.
URL base: https://cargoinsureonline.com/wp-json/api/v2
Cabeçalhos da API:
api_key: API_KEY
api_sec: API_SEC
Obtenha todas as opções de seguro
A API de opções Get All Insurance fornece todas as opções, como países, tipos de grupo, tipos de risco, tipos de transporte e moedas que você precisa selecionar ao comprar um novo seguro.
Ponto final: /get-cargo-insurance-options
Método API: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-cargo-insurance-options' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
Obtenha todos os países
A API de opções Obter todos os países fornece uma lista de países, essenciais para processos de logística e seguros internacionais.
Ponto final: / get-cargo-insurance-options ?type=countries
Método API: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-cargo-insurance-options?type=countries' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC '
Obtenha todos os tipos de grupo
A API Get All Group Types fornece a lista de todos os tipos de grupos sob os quais sua carga se enquadra, como comércio eletrônico, obras de arte, carga geral, etc.
Ponto final: / get-cargo-insurance-options ?type=group_types
Método API: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=group_types' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
Obtenha todos os tipos de risco
A API Get All Risk Types fornece uma lista de todos os riscos que sua carga pode enfrentar, de acordo com você.
Ponto final: /g et-cargo-insurance-options ?type=risk_types
Método API: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=risk_types' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
Obtenha todos os tipos de transporte
A API Get All Transport Types fornece a lista de todos os métodos de transporte pelos quais sua carga pode passar, como AÉREO, MARÍTIMO, ESTRADO, COURIER, etc.
Ponto final: / get-cargo-insurance-options ?type=transport_types
Método API: GET
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
Obtenha todas as moedas
A API Get All Currencies fornece aos usuários uma lista detalhada de moedas globais, essenciais para o comércio internacional e transações financeiras.
Ponto final: / get-cargo-insurance-options ?type=currencies
Método API: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=currencies' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
Obtenha todas as operadoras
A API Get All Carriers fornece uma lista de todas as transportadoras usadas pela maioria dos clientes, como Chronopost, DHL, FedEx, UPS, etc.
Ponto final: / get-cargo-insurance-options ?type=carriers
Método API: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=currencies' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
Compre seguro de carga
A API Buy Insurance permite que os usuários adquiram seguro de carga para suas remessas com eficiência. Ao acessar o endpoint /buy-cargo-insurance , os usuários podem enviar uma solicitação POST com informações detalhadas da remessa e do cliente para garantir a cobertura de seguro necessária. Esta API agiliza o processo de obtenção de seguro de carga, garantindo proteção oportuna e precisa para os embarques.
Ponto final: /buy-cargo-insurance
Obter taxa de seguro de carga
Você pode usar esta API para obter as taxas de seguro sem comprá-lo. Aceita todos os dados iguais ao buy-cargo-insurance e só retorna os dados do seguro com menor preço.
Ponto final: /get-cargo-insurance-rates
Obtenha informações de reclamações para qualquer usuário
A API Obter todas as informações de declarações retornará todos os detalhes, valor da declaração, documentos, etc. Ela será baseada na chave da API e nos cabeçalhos secretos da API usados na chamada da API.
Ponto final: /get-claims-by-user-id
Método API: GET
Exemplo de resposta:
[{
“id”: “1”,
“user_id”: “101”,
“policy_number”: “A123”,
“company_name”: “Example Insurance Co.”,
“contact_name”: “John Doe”,
“e-mail”: “johndoe@example.com”,
“telefone”: “1234567890”,
“claim_value”: “500,00”,
“date_of_loss”: “2024-01-01”,
“descrição”: “Amostra de descrição da reivindicação”,
“documentos”: “a:2:{i:0;s:94:\”https://example.com/files/sample- image1.png\”;i:1;s:88:\”https://example.com/files/sample-document1.pdf\”;}”,
“status”: “Em revisão”,
“observações”: “Verificação em andamento”,
“claim_date”: “2024-01-02 10:00:00”
}]
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-claims-by-user-id' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'