Enviar Certificação em Massa

Upload em Massa de Certificações

POST https://api.iafcertsearch.org/api/client/v1/mncb/bulk-upload-cert

Campos marcados com asterisco (*) são obrigatórios.

O símbolo ([*]) indica que um campo específico faz parte de uma matriz de objetos de certificação.

Headers

NameTypeDescription

Content-Type*

String

application/json

x-http-authorization*

String

Chave da API recebida de https://iafcertsearch.org/import-management/api-integration

Exemplo:

x-http-authorization: <<API KEY>>

Request Body

NameTypeDescription

certifications.[*]*

String

{

"certifications" : [

{

"certificate_number": "string",

"certification_status": "string",

. . . .

}

]

}

certifications.[*].certificate_number*

String

certifications.[*].certification_status*

String

Valores aceitos:

ativo

inativo

suspenso

cancelado

oculto

retirado

expirado

*Nota: Certificações enviadas via API com o hidden certification_status são exibidas como "Rascunho" quando você faz login no IAF CertSearch.

certifications.[*].certificate_accreditation_status

String

Valores aceitos:

Acreditado

Não acreditado

certifications.[*].certification_type*

String

certifications.[*].certification_scope

String

certifications.[*].certification_original_issue_date

String

Formato: AAAAMMDD

certifications.[*].certification_issue_date*

String

Formato: AAAAMMDD

certifications.[*].certification_expiry_date*

String

Formato: AAAAMMDD

certifications.[*].certified_entity_name*

String

certifications.[*].certified_entity_english_name

String

certifications.[*].certified_entity_trading_name

String

certifications.[*].certified_entity_unique_id*

String

certifications.[*].certified_entity_street_address

String

certifications.[*].certified_entity_street_city

String

certifications.[*].certified_entity_state

String

certifications.[*].certified_entity_post_code

String

certifications.[*].certified_entity_country*

String

certifications.[*].certified_entity_website

String

certifications.[*].confidential_certified_entity

Boolean

certifications.[*].accreditation_body_name*

String

certifications.[*].accreditation_body_acronym_name*

String

certifications.[*].certification_body_name*

String

certifications.[*].certification_body_acronym_name*

String

certifications.[*].schemes*

Array

Exemplo

{

"schemes": [

{

"scheme_name": "string",

"standard_list": [

{

"standards_name": "string"

}

]

}

]

}

certifications.[*].sites

Array

Exemplo

{

"sites": [

{

"street": "string",

&#x

20; "city": "string",

"state": "string",

"country": "string",

"postcode": "string",

"scope_description": "string

}

]

}

Para excluir todos os sites existentes de uma certificação, defina o valor da chave sites como uma matriz vazia, assim:

{

"sites": []

}

{
  "data": {
    "success": true
  }
}

Carregamento em Massa de Certificações

Recomendamos um intervalo de 10 minutos entre as solicitações da API para evitar erros durante a publicação dos dados de certificação.

Para ver o exemplo de dados de resposta, clique na seta à direita da descrição da resposta.

Você também pode utilizar https://api.sandbox.iafcertsearch.org/api/client/v1/mncb/bulk-upload-cert para testar no servidor Sandbox.

Dê uma olhada em como você poderia chamar esse método:

curl --location --request POST 'https://api.iafcertsearch.org/api/client/v1/mncb/bulk-upload-cert' \
--header 'Content-Type: application/json' \
--header 'x-http-authorization: <<API_KEY>>' \
--data-raw '{
    "certifications": [
        {
            "certificate_number": "string",
            "certification_status": "string",
            "certificate_accreditation_status": "string",
            "certification_type": "string",
            "certification_scope": "string",
            "certification_original_issue_date": "string",
            "certification_issue_date": "string",
            "certification_expiry_date": "string",
            "certified_entity_name": "string",
            "certified_entity_english_name": "string",
            "certified_entity_trading_name": "string",
            "certified_entity_unique_id": "string",
            "certified_entity_street_address": "string",
            "certified_entity_street_city": "string",
            "certified_entity_state": "string",
            "certified_entity_post_code": "string",
            "certified_entity_country": "string",
            "certified_entity_website": "string",
            "accreditation_body_name": "string",
	    "accreditation_body_acronym_name": "string",
            "certification_body_name": "string",
	    "certification_body_acronym_name": "string",
            "confidential_certified_entity": "boolean",
            "schemes": [
                {
                    "scheme_name": "string",
                    "standard_list": [
                        {
                            "standards_name": "string"
                        }
                    ]
                }
            ],
            "sites": [
                {
                    "street": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string",
                    "postcode": "string",
                    "scope_description": "string"
                }
            ]
        }
    ]
}'

Last updated