์ฝํธ๋๋ก๋ฆฌ์ ์ฆ๋ช ์
API ๋ ํผ๋ฐ์คโ
์๋ํฌ์ธํธโ
https://api.verifik.co/v2/co/contraloria/certificado
๋ณธ ์๋น์ค๋ ๋ฌธ์ ์ข ๋ฅ์ ๋ฒํธ๋ฅผ ์ ๋ ฅํ์ฌ ์ฝ๋กฌ๋น์ ์ด๊ฐ์ฌ์(Contralorรญa General de Colombia)์ด ๋ฐ๊ธํ ํํ ์ฆ๋ช ์๋ฅผ ๊ฒ์ฆํฉ๋๋ค. ์๋ต์๋ ์กฐํ ์ผ์์ ํจ๊ป base64๋ก ์ธ์ฝ๋ฉ๋ PDF ํ์์ ์ฆ๋ช ์๊ฐ ํฌํจ๋ฉ๋๋ค. ์ฝ๋กฌ๋น์ ๊ธฐ์ ๋๋ ๊ฐ์ธ์ ์ ์ ์ ๋ถ ์ํ๋ฅผ ์ ์ํ ํ์ธํ๋ ๋ฐ ์ ํฉํ ์๋น์ค์ ๋๋ค.
ํค๋(Headers)โ
| ์ด๋ฆ | ๊ฐ |
|---|---|
| Accept | application/json |
| Authorization | Bearer <token> |
๋งค๊ฐ๋ณ์(Parameters)โ
info
์ง์๋๋ ๋ฌธ์ ์ข ๋ฅ์ ์ ์ฒด ๋ชฉ๋ก๊ณผ ๊ฐ ์ข ๋ฅ๋ณ ํ์ ๋งค๊ฐ๋ณ์๋ Document Types ๊ฐ์ด๋๋ฅผ ์ฐธ๊ณ ํด ์ฃผ์ธ์.
| ์ด๋ฆ | ํ์ | ํ์ | ์ค๋ช |
|---|---|---|---|
documentType | string | ์ | ๋ฌธ์ ์ข ๋ฅ. ํ์ฉ ๊ฐ: CC, CE, PA, PEP. |
documentNumber | string | ์ | ์กฐํ ๋์์์ ๋ฌธ์ ๋ฒํธ. ๊ณต๋ฐฑ์ด๋ ์ ์์ด ์ ๋ ฅํฉ๋๋ค. |
์์ฒญ(Request)โ
- JavaScript
- Python
- Swift
- PHP
import axios from 'axios';
const options = {
method: 'GET',
url: 'https://api.verifik.co/v2/co/contraloria/certificado',
params: {documentType: 'CC', documentNumber: '123456789'},
headers: {
Accept: 'application/json',
Authorization: 'Bearer <your_token>'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
import http.client
conn = http.client.HTTPSConnection("api.verifik.co")
payload = ''
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer <your_token>'
}
conn.request("GET", "/v2/co/contraloria/certificado?documentType=CC&documentNumber=123456789", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var request = URLRequest(url: URL(string: "https://api.verifik.co/v2/co/contraloria/certificado?documentType=CC&documentNumber=123456789")!,
timeoutInterval: Double.infinity)
request.httpMethod = "GET"
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("Bearer <your_token>", forHTTPHeaderField: "Authorization")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.verifik.co/v2/co/contraloria/certificado?documentType=CC&documentNumber=123456789');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setHeader('Accept', 'application/json');
$request->setHeader('Authorization', 'Bearer <your_token>');
$request->setConfig(array(
'follow_redirects' => TRUE
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
์๋ต(Response)โ
- 200
- 404
- 409 (๋งค๊ฐ๋ณ์ ๋๋ฝ)
- 409 (์๋ชป๋ ๋ฌธ์ ์ข ๋ฅ)
{
"data": {
"documentType": "CC",
"documentNumber": "1020729123",
"searchDate": "2022-03-22T15:37:23.487Z",
"pdfBase64": "data:application/pdf;base64,STRING_BASE_64"
},
"signature": {
"dateTime": "March 22, 2022 4:37 AM",
"message": "Certified by Verifik.co"
}
}
{
"code": "NotFound",
"message": "Record not found."
}
{
"code": "MissingParameter",
"message": "missing documentType\n. missing documentNumber\n"
}
{
"code": "MissingParameter",
"message": "documentType must be one of: [CC, CE, PA, PEP]"
}