Crear grupo
curl --request POST \
--url https://api.athenahq.ai/api/v1/groups \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Enterprise Clients",
"website_ids": [
"123e4567-e89b-12d3-a456-426614174000",
"987e6543-e21b-12d3-a456-426614174000"
],
"billing_enabled": false,
"external_id": "acct_9e4c1b8d"
}
'import requests
url = "https://api.athenahq.ai/api/v1/groups"
payload = {
"name": "Enterprise Clients",
"website_ids": ["123e4567-e89b-12d3-a456-426614174000", "987e6543-e21b-12d3-a456-426614174000"],
"billing_enabled": False,
"external_id": "acct_9e4c1b8d"
}
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({
name: 'Enterprise Clients',
website_ids: ['123e4567-e89b-12d3-a456-426614174000', '987e6543-e21b-12d3-a456-426614174000'],
billing_enabled: false,
external_id: 'acct_9e4c1b8d'
})
};
fetch('https://api.athenahq.ai/api/v1/groups', 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.athenahq.ai/api/v1/groups",
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([
'name' => 'Enterprise Clients',
'website_ids' => [
'123e4567-e89b-12d3-a456-426614174000',
'987e6543-e21b-12d3-a456-426614174000'
],
'billing_enabled' => false,
'external_id' => 'acct_9e4c1b8d'
]),
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://api.athenahq.ai/api/v1/groups"
payload := strings.NewReader("{\n \"name\": \"Enterprise Clients\",\n \"website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"billing_enabled\": false,\n \"external_id\": \"acct_9e4c1b8d\"\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://api.athenahq.ai/api/v1/groups")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Enterprise Clients\",\n \"website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"billing_enabled\": false,\n \"external_id\": \"acct_9e4c1b8d\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/groups")
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 \"name\": \"Enterprise Clients\",\n \"website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"billing_enabled\": false,\n \"external_id\": \"acct_9e4c1b8d\"\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Enterprise Clients",
"orgId": "987e6543-e21b-12d3-a456-426614174000",
"billingEnabled": false,
"websiteIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2024-06-15T10:30:00.000Z",
"externalId": "acct_9e4c1b8d"
},
"billingEntityCreated": true
}Grupos
Crear grupo
Crea un grupo con sitios web asociados. Requiere una clave de API global. Las integraciones de socios pueden incluir external_id para vincular su identificador al nuevo grupo de Athena.
POST
/
api
/
v1
/
groups
Crear grupo
curl --request POST \
--url https://api.athenahq.ai/api/v1/groups \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Enterprise Clients",
"website_ids": [
"123e4567-e89b-12d3-a456-426614174000",
"987e6543-e21b-12d3-a456-426614174000"
],
"billing_enabled": false,
"external_id": "acct_9e4c1b8d"
}
'import requests
url = "https://api.athenahq.ai/api/v1/groups"
payload = {
"name": "Enterprise Clients",
"website_ids": ["123e4567-e89b-12d3-a456-426614174000", "987e6543-e21b-12d3-a456-426614174000"],
"billing_enabled": False,
"external_id": "acct_9e4c1b8d"
}
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({
name: 'Enterprise Clients',
website_ids: ['123e4567-e89b-12d3-a456-426614174000', '987e6543-e21b-12d3-a456-426614174000'],
billing_enabled: false,
external_id: 'acct_9e4c1b8d'
})
};
fetch('https://api.athenahq.ai/api/v1/groups', 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.athenahq.ai/api/v1/groups",
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([
'name' => 'Enterprise Clients',
'website_ids' => [
'123e4567-e89b-12d3-a456-426614174000',
'987e6543-e21b-12d3-a456-426614174000'
],
'billing_enabled' => false,
'external_id' => 'acct_9e4c1b8d'
]),
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://api.athenahq.ai/api/v1/groups"
payload := strings.NewReader("{\n \"name\": \"Enterprise Clients\",\n \"website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"billing_enabled\": false,\n \"external_id\": \"acct_9e4c1b8d\"\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://api.athenahq.ai/api/v1/groups")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Enterprise Clients\",\n \"website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"billing_enabled\": false,\n \"external_id\": \"acct_9e4c1b8d\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/groups")
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 \"name\": \"Enterprise Clients\",\n \"website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"billing_enabled\": false,\n \"external_id\": \"acct_9e4c1b8d\"\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Enterprise Clients",
"orgId": "987e6543-e21b-12d3-a456-426614174000",
"billingEnabled": false,
"websiteIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2024-06-15T10:30:00.000Z",
"externalId": "acct_9e4c1b8d"
},
"billingEntityCreated": true
}Cuerpo
application/json
Cuerpo de la solicitud para crear un grupo
Nombre del grupo.
Minimum string length:
1Ejemplo:
"Enterprise Clients"
Lista de ID de sitios web que se incluirán en el grupo. Todos deben pertenecer a tu organización. Los ID duplicados se reducen a una única pertenencia.
Minimum array length:
1Ejemplo:
[
"123e4567-e89b-12d3-a456-426614174000",
"987e6543-e21b-12d3-a456-426614174000"
]
Indica si se activará la facturación de este grupo
Ejemplo:
false
Solo socios. Identificador de tu sistema que se vinculará a este grupo de Athena. Solo se admite con una clave de API de una organización marcada como socio. Los clientes directos reciben 403 Forbidden. Debe ser único por tipo de recurso en tu organización; los duplicados devuelven 409 con el recurso existente en los datos de respuesta.
Minimum string length:
1Ejemplo:
"acct_9e4c1b8d"
Respuesta
Grupo creado correctamente
Un recurso de grupo recién creado
Show child attributes
Show child attributes
Solo aparece si se solicita billing_enabled: indica si existe la entidad de facturación tras el aprovisionamiento. Si es false, ha fallado incluso tras reintentar y configurar créditos devuelve 400 hasta reparar la facturación con PATCH /api/v1/groups/{group_id} y billing_enabled: true.
¿Esta página le ayudó?