Ouvrir une session de page

POST/v1/browser-sessions

À appeler depuis votre serveur, avec votre clé secrète, puis à passer à la page par client_secret. La page s’en sert pour piloter un poste, sans jamais voir de clé d’API. Valable trente minutes, pour une seule origine.

Droit de clé restreinte : workstations:write.

Corps de la requête

origintexteobligatoire
L'origine de la page qui recevra le secret. Elle doit figurer parmi les origines autorisées du mode.
workstationtexteou null
Le poste à piloter, si votre serveur le connaît. Sans lui, la page s'associe par le code que montre l'agent.

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend l’objet sessions de page.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/browser-sessions \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"origin":"https://app.exemple.fr"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/browser-sessions', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'origin' => 'https://app.exemple.fr',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/browser-sessions', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    origin: 'https://app.exemple.fr'
  }),
})
const object = await response.json()

Réponse 201


{
  "id": "obj_…",
  "object": "browser_session",
  "client_secret": "…",
  "origin": "…",
  "workstation": null,
  "linked_at": null,
  "expires_at": null,
  "created": 1793970000,
  "livemode": false
}