XTRF | Operate As Docs

Connect your client's XTRF with a key they paste, and call its API through Operate As.

Website: xtrf.eu
Connects by: Pasting a Access token
Category: Projects and tasks
Services: 1
Tools: 253

Service	Key	Base URL
XTRF	`xtrf`	`https://{host}/home-api`

Your client also types their xtrf address (Your XTRF server, such as acme.s.xtrf.eu).

Connecting

Your client makes a Access token in their XTRF settings and pastes it on their link. Operate As tries it with XTRF before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "xtrf"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "xtrf"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the XTRF key you paste, with only the access you gave that key	Chosen on the provider's screen

Tools

Install XTRF's typed package for your language:

pip install operate-as-xtrf

pip install operate-as-xtrf

Run xtrf.add_external_file_link

curl -X POST https://api.operate.as/v1/actions/xtrf.add_external_file_link \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {
      "job_id": "<job_id>"
    }
  }'

curl -X POST https://api.operate.as/v1/actions/xtrf.add_external_file_link \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {      "job_id": "<job_id>"    }  }'

Shows the required inputs. Every input, with its JSON Schema: GET /v1/actions/xtrf.add_external_file_link

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://{host}/home-api, with the parts in braces filled in from your client's account. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../xtrf/users" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../xtrf/users" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in XTRF. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}