@firma-dev/sdk

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.emailDomains.createWorkspaceDomain({
    workspace_id: "workspace_id",
    domain: "sales.acme.com"
});
console.log(response);

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "sales.acme.com"
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains"

payload = { "domain": "sales.acme.com" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'sales.acme.com'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains', 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://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains",
  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([
    'domain' => 'sales.acme.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains"

	payload := strings.NewReader("{\n  \"domain\": \"sales.acme.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"sales.acme.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"sales.acme.com\"\n}"

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

{
  "domain": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "domain": "sales.acme.com",
    "verification_status": 0,
    "domain_status": 0,
    "is_primary": false,
    "verification_token": "firma-verify=abc123xyz",
    "date_created": "2024-01-15T10:30:00Z",
    "date_changed": "2024-01-15T10:30:00Z"
  },
  "verification_instructions": {
    "record_type": "TXT",
    "record_name": "_firma-verification.sales.acme.com",
    "record_value": "firma-verify=abc123xyz",
    "next_step": "Add this TXT record to your DNS, then call POST /workspace/{workspace_id}/domains/{id}/verify-ownership"
  }
}

Domaines de Messagerie

Ajouter un domaine à l'espace de travail

Ajouter un nouveau domaine email pour un espace de travail spécifique. Cela lance le processus de vérification du domaine. Après la création, vous devez :

Ajouter un enregistrement TXT à votre DNS avec le jeton de vérification
Appeler POST /workspace//domains//verify-ownership pour vérifier la propriété du domaine
Appeler POST /workspace//domains//finalize pour l’enregistrer auprès du fournisseur d’email
Ajouter les enregistrements DNS retournés (SPF, DKIM, etc.)
Appeler POST /workspace//domains//verify-dns pour terminer la vérification

POST

workspace

{workspace_id}

domains

@firma-dev/sdk

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.emailDomains.createWorkspaceDomain({
    workspace_id: "workspace_id",
    domain: "sales.acme.com"
});
console.log(response);

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "sales.acme.com"
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains"

payload = { "domain": "sales.acme.com" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'sales.acme.com'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains', 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://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains",
  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([
    'domain' => 'sales.acme.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains"

	payload := strings.NewReader("{\n  \"domain\": \"sales.acme.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"sales.acme.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"sales.acme.com\"\n}"

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

{
  "domain": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "domain": "sales.acme.com",
    "verification_status": 0,
    "domain_status": 0,
    "is_primary": false,
    "verification_token": "firma-verify=abc123xyz",
    "date_created": "2024-01-15T10:30:00Z",
    "date_changed": "2024-01-15T10:30:00Z"
  },
  "verification_instructions": {
    "record_type": "TXT",
    "record_name": "_firma-verification.sales.acme.com",
    "record_value": "firma-verify=abc123xyz",
    "next_step": "Add this TXT record to your DNS, then call POST /workspace/{workspace_id}/domains/{id}/verify-ownership"
  }
}

Autorisations

Authorization

string

header

requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

workspace_id

string<uuid>

requis

ID de l'espace de travail

Corps

application/json

domain

string

requis

Nom de domaine à ajouter (par ex., 'example.com'). Doit être un format de domaine valide.

Exemple:

"sales.acme.com"

Réponse

Domaine créé avec succès. Ajoutez l'enregistrement TXT de vérification à votre DNS.

Domaine créé avec les instructions de vérification

domain

object

requis

Configuration de domaine email pour l'envoi des emails de Demande de Signature

Show child attributes

verification_instructions

object

requis

Show child attributes

Lister les domaines de l'espace de travail Récupérer un domaine de l'espace de travail

⌘I