Certificação de Carregamento em Massa"

Upload em Massa de Certificação

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

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

O símbolo ([*]) é usado para indicar que um campo específico faz parte de um array de objetos de certificação.

Headers

Name	Type	Description
Content-Type*	String	application/json
x-http-authorization*	String	Chave de API recebida de https://iafcertsearch.org/import-management/api-integration Exemplo: x-http-authorization: <<CHAVE DA API>>

Request Body

Name	Type	Description
certifications.[*]*	String	{ "certifications" : [ { "certificate_number": "string", "certification_status": "string", . . . . } ] }
certifications.[*].certificate_number*	String
certifications.[*].certification_status*	String
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
certifications.[*].certification_issue_date*	String
certifications.[*].certification_expiry_date*	String
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_city	String
certifications.[*].certified_entity_state	String
certifications.[*].certified_entity_post_code	String
certifications.[*].certified_entity_country*	String
certifications.[*].certification_body_name*	String
certifications.[*].certification_body_acronym_name	String
certifications.[*].certification_body_identity_number*	String
certifications.[*].confidential_certified_entity	Boolean
certifications.[*].schemes*	Array	Exemplo { "schemes": [ { "scheme_name": "string", "standard_list": [ { "standards_name": "string" } ] } ] }
certifications.[*].sites	Array	Exemplo { "sites": [ { "street": "string", "city": "string", "state": "string", "country": "string", "postcode": "string", "scope_description": "string" } ] }

200: OK Requisição bem-sucedida.

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

400: Solicitação Inválida Outros erros descritos na resposta da API.

{
    "data": {
      "errors": {
        "record_index": 0,
        "errors": [
          {
            "message": "mensagem_de_erro",
            "code": "código_de_erro",
            "meta": {
              "field_name": "entrada"
            }
          }
        ]
      }
    }
}

401: Não Autorizado Ocorre quando se utiliza uma Chave de API inválida.

{
    "error": true,
    "timestamp": número (tempo Epoch),
    "elapse": número,
    "errors": {
      "message": "Foi utilizado um token de sessão inválido.",
      "code": "token_de_sessão_inválido"
    }
}

422: Entidade Não Processável Não passou na validação.

{
    "error": true,
    "timestamp": número (tempo Epoch),
    "elapse": número,
    "errors": {
        "code": "erro_de_validação",
        "message": {
            "field_name": "mensagem_de_erro"
        }
    }
}

Upload em Massa de Certificação

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 dos dados de resposta, clique na seta à direita da descrição da resposta.

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

Veja como você pode chamar este método:

cURL

curl --location --request POST 'https://api.iafcertsearch.org/api/client/v1/ab/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",
            "certification_body_name": "string",
            "certification_body_acronym_name": "string",
            "certification_body_identity_number": "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"
                }
            ]
        }
    ]
}'

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.iafcertsearch.org/api/client/v1/ab/bulk-upload-cert")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["x-http-authorization"] = "<<API_KEY>>"
request.body = JSON.dump({
  "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",
      "certification_body_name": "string",
      "certification_body_acronym_name": "string",
      "certification_body_identity_number": "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"
        }
      ]
    }
  ]
})

response = https.request(request)
puts response.read_body

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.iafcertsearch.org")
payload = json.dumps({
  "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",
      "certification_body_name": "string",
      "certification_body_acronym_name": "string",
      "certification_body_identity_number": "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"
        }
      ]
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'x-http-authorization': '65603d8724a92'
}
conn.request("POST", "/api/client/v1/ab/bulk-upload-cert", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.iafcertsearch.org/api/client/v1/ab/bulk-upload-cert',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "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",
            "certification_body_name": "string",
            "certification_body_acronym_name": "string",
            "certification_body_identity_number": "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"
                }
            ]
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'x-http-authorization: <<API_KEY>>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"certifications\": [\n        {\n            \"certificate_number\": \"string\",\n            \"certification_status\": \"string\",\n            \"certificate_accreditation_status\": \"string\",\n            \"certification_type\": \"string\",\n            \"certification_scope\": \"string\",\n            \"certification_original_issue_date\": \"string\",\n            \"certification_issue_date\": \"string\",\n            \"certification_expiry_date\": \"string\",\n            \"certified_entity_name\": \"string\",\n            \"certified_entity_english_name\": \"string\",\n            \"certified_entity_trading_name\": \"string\",\n            \"certified_entity_unique_id\": \"string\",\n            \"certified_entity_street_address\": \"string\",\n            \"certified_entity_street_city\": \"string\",\n            \"certified_entity_state\": \"string\",\n            \"certified_entity_post_code\": \"string\",\n            \"certified_entity_country\": \"string\",\n            \"certification_body_name\": \"string\",\n            \"certification_body_acronym_name\": \"string\",\n            \"certification_body_identity_number\": \"string\",\n            \"confidential_certified_entity\": \"boolean\",\n            \"schemes\": [\n                {\n                    \"scheme_name\": \"string\",\n                    \"standard_list\": [\n                        {\n                            \"standards_name\": \"string\"\n                        }\n                    ]\n                }\n            ],\n            \"sites\": [\n                {\n                    \"street\": \"string\",\n                    \"city\": \"string\",\n                    \"state\": \"string\",\n                    \"country\": \"string\",\n                    \"postcode\": \"string\",\n                    \"scope_description\": \"string\"\n                }\n            ]\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("https://api.iafcertsearch.org/api/client/v1/ab/bulk-upload-cert")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("x-http-authorization", "<<API_KEY>>")
  .build();
Response response = client.newCall(request).execute();

Node.js

var axios = require('axios');
var data = JSON.stringify({
  "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",
      "certification_body_name": "string",
      "certification_body_acronym_name": "string",
      "certification_body_identity_number": "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"
        }
      ]
    }
  ]
});
var config = {
  method: 'post',
  url: 'https://api.iafcertsearch.org/api/client/v1/ab/bulk-upload-cert',
  headers: { 
    'Content-Type': 'application/json', 
    'x-http-authorization': '<<API_KEY>>'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.iafcertsearch.org/api/client/v1/ab/bulk-upload-cert"
  method := "POST"

  payload := strings.NewReader(`{
    "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",
            "certification_body_name": "string",
            "certification_body_acronym_name": "string",
            "certification_body_identity_number": "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"
                }
            ]
        }
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("x-http-authorization", "<<API_KEY>>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

C#

var client = new RestClient("https://api.iafcertsearch.org/api/client/v1/ab/bulk-upload-cert");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("x-http-authorization", "<<API_KEY>>");
var body = @"{" + "\n" +
@"    ""certifications"": [" + "\n" +
@"        {" + "\n" +
@"            ""certificate_number"": ""string""," + "\n" +
@"            ""certification_status"": ""string""," + "\n" +
@"            ""certificate_accreditation_status"": ""string""," + "\n" +
@"            ""certification_type"": ""string""," + "\n" +
@"            ""certification_scope"": ""string""," + "\n" +
@"            ""certification_original_issue_date"": ""string""," + "\n" +
@"            ""certification_issue_date"": ""string""," + "\n" +
@"            ""certification_expiry_date"": ""string""," + "\n" +
@"            ""certified_entity_name"": ""string""," + "\n" +
@"            ""certified_entity_english_name"": ""string""," + "\n" +
@"            ""certified_entity_trading_name"": ""string""," + "\n" +
@"            ""certified_entity_unique_id"": ""string""," + "\n" +
@"            ""certified_entity_street_address"": ""string""," + "\n" +
@"            ""certified_entity_street_city"": ""string""," + "\n" +
@"            ""certified_entity_state"": ""string""," + "\n" +
@"            ""certified_entity_post_code"": ""string""," + "\n" +
@"            ""certified_entity_country"": ""string""," + "\n" +
@"            ""certification_body_name"": ""string""," + "\n" +
@"            ""certification_body_acronym_name"": ""string""," + "\n" +
@"            ""certification_body_identity_number"": ""string""," + "\n" +
@"            ""confidential_certified_entity"": ""boolean""," + "\n" +
@"            ""schemes"": [" + "\n" +
@"                {" + "\n" +
@"                    ""scheme_name"": ""string""," + "\n" +
@"                    ""standard_list"": [" + "\n" +
@"                        {" + "\n" +
@"                            ""standards_name"": ""string""" + "\n" +
@"                        }" + "\n" +
@"                    ]" + "\n" +
@"                }" + "\n" +
@"            ]," + "\n" +
@"            ""sites"": [" + "\n" +
@"                {" + "\n" +
@"                    ""street"": ""string""," + "\n" +
@"                    ""city"": ""string""," + "\n" +
@"                    ""state"": ""string""," + "\n" +
@"                    ""country"": ""string""," + "\n" +
@"                    ""postcode"": ""string""," + "\n" +
@"                    ""scope_description"": ""string""" + "\n" +
@"                }" + "\n" +
@"            ]" + "\n" +
@"        }" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);