Naar de inhoud springen
Geverifieerd

Projecten en deployments opvragen

Elke workspace van een account, en dan elke app die echt draait, als twee leesaanroepen op een CouchDB-view.

"Projecten" en "deployments" beantwoorden twee verschillende vragen. Een project is een workspace op het account, wat je zou zien in de projectwisselaar, of er nu ooit iets in live is gegaan of niet. Een deployment is één app die echt ergens draait, is_deployment: true op zijn eigen document. Een account opvragen betekent meestal allebei: eerst de workspaces, dan wat er in elk daarvan draait.

Methoden

POST/cpi/get_account_projects
user

Get Account Projects

Returns the projects owned by the account (or all projects for superuser and support accounts) from the user_projects master view.

POST/cpi/get_account_deployments
user

Get Account Deployments

Returns the deployments associated with the account from the user_deployments master view.

Stappenplan

Vraag de projecten van het account op

Geen velden behalve je sleutel: beide methoden halen de CouchDB-view op met de uid waarnaar je inloggegevens al verwijzen.

curl -s https://xuda.ai/cpi/get_account_projects \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_projects', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) {
  for (const row of data.rows) console.log(row.id, row.value.app_name, row.value.app_status_code);
}
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_projects',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value']['app_name'], row['value']['app_status_code'])

2. Vraag op wat echt gedeployd is

Dezelfde vorm, een andere view: user_deployments geeft alleen een document als is_deployment waar is, dus deze lijst is een deelverzameling van alle apps die het account ooit heeft gemaakt: die met een live toegangs-URL.

curl -s https://xuda.ai/cpi/get_account_deployments \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_deployments', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) {
  for (const row of data.rows) console.log(row.id, row.value.app_hosting, row.value.app_status_code);
}
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_deployments',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value']['app_hosting'], row['value']['app_status_code'])

Het antwoord

Beide methoden geven een CouchDB-viewresultaat rechtstreeks door, zonder omhulling: code is 871 (de vaste succescode die get_couch_view altijd teruggeeft, niet de gebruikelijke 1), en data is het ruwe nano-viewantwoord: total_rows, offset en een array rows met { id, key, value }. id is de _id van het project (of de deployment), de waarde die je als app_id meegeeft aan elke andere aanroep in deze sectie.

json
{
  "code": 871,
  "data": {
    "total_rows": 3,
    "offset": 0,
    "rows": [
      {
        "id": "app_5d9e21",
        "key": "acc_8f2a1c",
        "value": {
          "_id": "app_5d9e21",
          "app_name": "Marketing site",
          "app_type": "master",
          "app_status_code": 3,
          "app_access_type": "private",
          "docDate": 1735689600000,
          "app_icon_prop": { "app_icon_background_color": "#4f46e5", "app_icon_size": "md" }
        }
      }
    ]
  }
}

Rijen van get_account_deployments hebben dezelfde velden plus app_hosting_server, app_datacenter_id, app_hosting en is_deployment: true, omdat user_deployments die erbovenop geeft. app_status_code < 4 is de enige status die deze view of user_projects je ooit laat zien: beide mapfuncties filteren alles op 4 of hoger weg, dus een verwijderd project verdwijnt gewoon in plaats van te verschijnen met een status om te controleren.

De rij van een workspace kan een andere naam hebben

get_account_projects zet main_profile_name op de rij van de eigen workspace van het account als die workspace een benoemd profiel heeft, dus de rij die je als "jouw" project toont kan anders heten dan de opgeslagen app_name. Geef de voorkeur aan main_profile_name als die er is.

Fouten

Beide methoden falen alleen op de manier waarop elke aanroep kan falen: een ontbrekende of niet toegestane api_key (-401, zie Errors). Geen van beide kijkt naar app_id of een andere input, omdat ze er geen hebben. Een lege array rows is een echt, geslaagd antwoord voor een account dat nog niets in die lijst heeft, geen fout.

Volgende stap