curl --request POST \
--url https://app.blockgence.com/v1/audit \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": [
"<string>"
],
"spec": "<string>",
"project": "<string>"
}
'import requests
url = "https://app.blockgence.com/v1/audit"
payload = {
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": ["<string>"],
"spec": "<string>",
"project": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repo: '<string>',
commit: '<string>',
level: 'automated',
files: ['<string>'],
spec: '<string>',
project: '<string>'
})
};
fetch('https://app.blockgence.com/v1/audit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/audit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repo' => '<string>',
'commit' => '<string>',
'level' => 'automated',
'files' => [
'<string>'
],
'spec' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/audit"
payload := strings.NewReader("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/audit")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/audit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Pedir una revisión de smart contracts
Registra un pedido de revisión de smart contracts para su organización.
Cuerpo del pedido (JSON).
repo(obligatorio): repositorio público de GitHub,https://github.com/<dueño>/<repo>. Por ahora no se aceptan repositorios privados ni archivos comprimidos.commit(obligatorio): hash completo del commit (40 hex). Todo el informe se refiere a ese commit.level:automated(por defecto),assistedoaudit. El nivelauditrequierespec.files: rutas o patrones relativos al repositorio; con!al inicio, excluyen. Hasta 50. Por defecto,src/**/*.solsin tests, scripts nilib/.spec: especificación o documento de diseño, hasta 50,000 caracteres. Opcional, salvo en el nivelaudit.project: nombre para el panel; por defecto, el del repositorio.
Respuesta. 201 con {demo, note, audit_id, audit, queue}. audit tiene la forma de una fila de
GET /v1/audit, con run.state: "queued" y requested: true. Es una revisión real de su organización
(demo: false), visible solo para ella.
Disponibilidad. La ejecución de auditorías estará disponible próximamente. Hasta entonces, la revisión queda
registrada en cola, pero no se ejecuta: queue.state es not_enqueued y note lo indica. Cuando la ejecución
esté disponible, queue.state será enqueued. Las secciones de la revisión están vacías, salvo deploy y
notas: no se completan con datos de ejemplo, que serían hallazgos inventados sobre su código. Una sección
vacía no significa «sin hallazgos».
Errores. Con cuerpo {"error": …, "detail": …}:
400:bad_repo,bad_commit,bad_level,bad_files,spec_requiredospec_too_long.403 org_required: una clave de API sin organización no puede pedir revisiones.403 read_only: el rol es de solo lectura.409 too_many_queued: la organización ya tiene 50 revisiones en cola sin ejecutar.503 queue_unavailable: no se pudo encolar la revisión; no se registra nada.
Costo: sin cargo.
curl --request POST \
--url https://app.blockgence.com/v1/audit \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": [
"<string>"
],
"spec": "<string>",
"project": "<string>"
}
'import requests
url = "https://app.blockgence.com/v1/audit"
payload = {
"repo": "<string>",
"commit": "<string>",
"level": "automated",
"files": ["<string>"],
"spec": "<string>",
"project": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repo: '<string>',
commit: '<string>',
level: 'automated',
files: ['<string>'],
spec: '<string>',
project: '<string>'
})
};
fetch('https://app.blockgence.com/v1/audit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/audit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repo' => '<string>',
'commit' => '<string>',
'level' => 'automated',
'files' => [
'<string>'
],
'spec' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/audit"
payload := strings.NewReader("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/audit")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/audit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repo\": \"<string>\",\n \"commit\": \"<string>\",\n \"level\": \"automated\",\n \"files\": [\n \"<string>\"\n ],\n \"spec\": \"<string>\",\n \"project\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Autorizaciones
Encabezados
Cuerpo
Respuesta
Revisión registrada.