API do Registro de Rede

O processo de solicitação de aprovação detalhado no Registro de Rede O guia também pode ser gerenciado programaticamente usando o API do Registro de Rede. Isso permite que o processo de aprovação seja gerenciado de forma automatizada.

Referência da API

A especificação OpenAPI para a API do Registro de Rede já está disponível aqui.

Autenticação

A autenticação é baseada no seu Chave da API e Segredo da API, que pode ser encontrado no painel do desenvolvedor.

Gerenciamento de perfis de empresas

Você pode criar, consultar e excluir perfis empresariais usando o /business-profile ponto final.

O exemplo a seguir é uma solicitação POST que cria um novo perfil empresarial chamado “Meu perfil empresarial”, solicitando acesso a operadoras na Espanha e na Alemanha. O corpo da solicitação contém as mesmas informações solicitadas pelo painel do Registro de Rede (função, país, número de identificação fiscal, etc.):

curl -X POST "http://api-eu.vonage.com/v1/network-registry/business-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "countries": [
      "ES",
      "DE"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organization_type": "forProfitOrganization",
   "tax_number": "98284687G",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "privacy_policy_url": "https://www.businessinc.com/privacy_policy",
   "privacy_policy_manager_email": "privacy.manager@business.com",
   "dpo_email": "dpo@business.com",
   "dpo_required": true,
   "terms_and_conditions_accepted": true,
   "business_information": {
      "address_street_1": "Main Street 5",
      "address_street_2": "Extra long address",
      "postal_code": "W1 5DU",
      "country": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}'

Para modificar um perfil de empresa, envie uma solicitação PUT usando /change-request e o ID do seu perfil empresarial:

curl -X PUT "http://api-eu.vonage.com/v1/network-registry/business-profiles/$BUSINESS-PROFILE-ID/change-request" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "countries": [
      "ES"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organization_type": "For-Profit Organization",
   "tax_number": "98284687G",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "privacy_policy_url": "https://www.businessinc.com/privacy_policy",
   "privacy_policy_manager_email": "privacy.manager@business.com",
   "dpo_email": "dpo@business.com",
   "dpo_required": true,
   "terms_and_conditions_accepted": true,
   "business_information": {
      "address_street_1": "Main Street 5",
      "address_street_2": "Extra long address",
      "postal_code": "W1 5DU",
      "country": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}'

Uma lista completa de todas as operações e parâmetros pode ser encontrada no Referência da API.

Gerenciamento de perfis de aplicativos

O /application-profiles O endpoint pode ser usado para realizar todas as operações relacionadas aos perfis de aplicativo. Este exemplo envia uma solicitação POST para criar um novo perfil de aplicativo:

curl -X POST "http://api-eu.vonage.com/v1/network-registry/application-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "name": "Network Application Profile",
   "description": "This Network Application Profile main use case is for Fraud Prevention",
   "category_id": "finance",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
   ],
   "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
}'

Uma lista completa de todas as operações e parâmetros pode ser encontrada no Referência da API.

Outras operações

O /catalogue ponto final pode ser usado para listar recursos úteis, como países, categorias, tipos de organizações ou finalidades:

[OBTER] /v1/network-registry/catalogue/countries: Lista de países compatíveis
[OBTER] /v1/network-registry/catalogue/organization-types: Lista dos tipos de organizações compatíveis
[OBTER] /v1/network-registry/catalogue/categories: Lista das categorias compatíveis
[OBTER] /v1/network-registry/catalogue/network-apis: Lista de recursos de rede compatíveis
[OBTER] /v1/network-registry/catalogue/purposes: Lista das finalidades permitidas