NAV
shell ruby python javascript

Einführung

Willkommen bei der Acvire-API! Sie können unsere API verwenden, um Leads zu verwalten, die mit Ihren Projekten verbunden sind. Diese Dokumentation bietet detaillierte Informationen zu API-Endpunkten und deren Verwendung.

Wir bieten Sprachbindungen für Shell, Ruby, Python und JavaScript! Sie können Codebeispiele im dunklen Bereich rechts einsehen und die Programmiersprache der Beispiele über die Registerkarten oben rechts wechseln.

Authentifizierung

Um sich zu autorisieren, verwenden Sie diesen Code:

Authorization: Bearer <your_api_token>

require 'net/http'

uri = URI("https://acvire.com/api/v1/leads")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <your_api_token>"

import requests

headers = {"Authorization": "Bearer <your_api_token>"}
response = requests.get("https://acvire.com/api/v1/leads", headers=headers)

const fetch = require('node-fetch');

const url = 'https://acvire.com/api/v1/leads';
const options = { method: 'GET', headers: { Authorization: 'Bearer <your_api_token>' } };

fetch(url, options).then(response => response.json()).then(console.log);

Die Acvire-API verwendet API-Token zur Authentifizierung. Fügen Sie Ihr API-Token in den Authorization-Header in allen API-Anfragen ein.

Endpunkte

Leads auflisten

GET /api/v1/leads?ref_code=abc123
Authorization: Bearer <your_api_token>

require 'net/http'

uri = URI("https://acvire.com/api/v1/leads?ref_code=abc123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <your_api_token>"

response = requests.get(
    "https://acvire.com/api/v1/leads",
    headers={"Authorization": "Bearer <your_api_token>"},
    params={"ref_code": "abc123"}
)

fetch('https://acvire.com/api/v1/leads?ref_code=abc123', {
  method: 'GET',
  headers: { Authorization: 'Bearer <your_api_token>' }
}).then(console.log);

Beispielantwort:

[
  {
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@example.com",
    "organisation": "Example Corp",
    "status": "new"
  }
]

Ruft alle Leads für das angegebene Projekt ab.

HTTP-Anfrage

GET /api/v1/leads

Abfrageparameter

Parameter Typ Beschreibung
ref_code string Referenzcode des Projekts (erforderlich).

Lead-Details anzeigen

GET /api/v1/leads/1
Authorization: Bearer <your_api_token>

require 'net/http'

uri = URI("https://acvire.com/api/v1/leads/1")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <your_api_token>"

response = requests.get(
    "https://acvire.com/api/v1/leads/1",
    headers={"Authorization": "Bearer <your_api_token>"}
)

fetch('https://acvire.com/api/v1/leads/1', {
  method: 'GET',
  headers: { Authorization: 'Bearer <your_api_token>' }
}).then(console.log);

Beispielantwort:

{
  "id": 1,
  "name": "John Doe",
  "email": "johndoe@example.com",
  "organisation": "Example Corp",
  "status": "new"
}

Ruft Details für einen bestimmten Lead ab.

HTTP-Anfrage

GET /api/v1/leads/:id

URL-Parameter

Parameter Typ Beschreibung
id string Die ID des Leads (erforderlich).

Einen Lead erstellen

POST /api/v1/leads
Authorization: Bearer <your_api_token>
Content-Type: application/json

{
  "ref_code": "abc123",
  "lead": {
    "name": "Jane Doe",
    "email": "janedoe@example.com",
    "organisation": "Example Corp"
  }
}

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://acvire.com/api/v1/leads")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer <your_api_token>"
request.body = JSON.dump({
  "ref_code" => "abc123",
  "lead" => {
    "name" => "Jane Doe",
    "email" => "janedoe@example.com",
    "organisation" => "Example Corp"
  }
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json"
}
data = {
    "ref_code": "abc123",
    "lead": {
        "name": "Jane Doe",
        "email": "janedoe@example.com",
        "organisation": "Example Corp"
    }
}

response = requests.post(
    "https://acvire.com/api/v1/leads",
    headers=headers,
    json=data
)

fetch('https://acvire.com/api/v1/leads', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <your_api_token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ref_code: 'abc123',
    lead: {
      name: 'Jane Doe',
      email: 'janedoe@example.com',
      organisation: 'Example Corp'
    }
  })
}).then(console.log);

Beispielantwort:

{
  "id": 2,
  "name": "Jane Doe",
  "email": "janedoe@example.com",
  "organisation": "Example Corp",
  "status": "new"
}

Erstellt einen neuen Lead für das angegebene Projekt.

HTTP-Anfrage

POST /api/v1/leads

Anfragekörper

Parameter Typ Beschreibung
ref_code string Referenzcode des Projekts (erforderlich).
lead object Lead-Attribute (erforderlich).

Lead-Attribute

Parameter Typ Beschreibung
name string Name des Leads.
email string E-Mail des Leads.
organisation string Name der Organisation.
Zusätzliche Felder variiert Gemäß lead_params.

Fehlerantworten

401 Nicht autorisiert

Tritt auf, wenn das Token fehlt, ungültig ist oder der Benutzer keinen Zugriff auf die Ressource hat.

Beispielantwort:

{
  "error": "Unauthorized: Invalid project or access denied"
}

422 Unverarbeitbare Entität

Tritt auf, wenn die Validierung der Lead-Attribute fehlschlägt.

Beispielantwort:

{
  "errors": ["Email can't be blank"]
}

Sicherheits- und Abonnementprüfungen

Token-Authentifizierung

Überprüft das Authorization-Token gegen User.api_token.

Abonnementprüfung

Stellt sicher, dass der Benutzer ein aktives Abonnement hat, bevor er auf Endpunkte zugreift.

Beispiel-Fehlermeldung:

Kein aktives Abo vorhanden. Bitte aktiviere dein Abo auf <subscription_url>

Entwicklerhinweise

shell ruby python javascript