Ag Úsáid Taiscéalaí GraphiQL Legalesign

Ligeann an Taiscéalaí GraphQL Legalesign duit ceisteanna agus mútuithe a thástáil i gcoinne an API beo, an scéim iomlán a bhrabhsáil, agus díchódaíocht a dhéanamh sular scríobhann tú cód.

Oscail an Taiscéalaí

Téigh go https://graphiql.legalesign.com/ agus logáil isteach leis na sonraí cuntas atá agat.

nóta

Mura bhfuil cuntas Legalesign agat fós, cláraigh le haghaidh triail saor in aisce.

Cruthaigh Ceist

Greamaigh an méid seo a leanas isteach sa bhfuinneog ceiste príomha:

query MyFirstQuery {
  user {
    id
    name
  }
}

De réir réamhshocraithe, má ghlaonn tú ar an n-ábhar user, is do chuid faisnéise féin a chuirtear ar ais. Rith an cheist trí chliceáil ar an gcnaipe súgartha atá i mbarr na barra uirlisí.

Ag Tuigbheáil na gTorthaí

{
  "data": {
    "user": {
      "id": "dXNyZTE2NBB1NWQtNWVjXS00NzIzL3G3NDI5ODEtZmFhOGFjYzdlMGRh",
      "name": "Bob Mortimer",
      "firstName": "Bob",
      "lastName": "Mortimer"
    }
  }
}

Tá ábhar data sa fhreagra le hábhar user ann — toisc gur iarramar ar aon aonaid User.

eolas

Is cás speisialta é User — mura dtugann tú id, glacann sé gur do chuid faisnéise úsáideora féin atá uait. Le cineálacha eile rudaí beidh ort an id sonrach a chur isteach i gcónaí:

query GetAGroup {
  group(id: 'zSJy2jhsdDF') {
    id
    name
  }
}

Conas Tuilleadh a Fhiosrú

Trí Chuardach

Sa chúinne uachtarach ar dheis, cliceáil < Docs chun an painéal doiciméadúcháin a oscailt. Sa bhosca Search Schema, clóscríobh User. Cliceáil an toradh barr chun gach réimse atá ar fáil ar an gcineál User a fheiceáil, le mínithe ar gach ceann.

Trí Bhrabhsáil

Mura bhfuil a fhios agat cén cineál atá uait, brabhsáil an scéim ina ionad sin. Sa Documentation Explorer, cliceáil < Back go dtí go mbeidh tú ag an mbunfhreagra. Feicfidh tú trí chineál bunúsach: Query, Mutation agus Subscription.

Cliceáil Query chun na cineálacha atá ar fáil a fheiceáil:

organisation(id: ID, orgId: ID): Organisation
Returns an Organisation.

group(id: ID, groupId: ID): Group
Returns a Group.

user(id: ID, userId: ID): User
Returns a User (or the current user if id is null).

Tabhair faoi deara go insíonn an cur síos ar User dúinn gur féidir an t-úsáideoir reatha a fháil trí id a fhágáil amach. Cliceáil ar aon chineál chun a réimsí a iniúchadh.

Athraigh an Cheist

Déan iniúchadh le réimsí breise a chur leis:

query MyFirstQuery {
  myInfo: user {
    id
    name
    canAdministerUsers
  }
}

Bí ag cliceáil ar an gcnaipe súgartha. Tá an toradh anois ag léiriú an réimse nua:

{
  "data": {
    "myInfo": {
      "id": "...",
      "name": "...",
      "canAdministerUsers": true
    }
  }
}

Léiríonn sé seo go bhfuil rochtain riarthóra ag an úsáideoir tástála — má tá tú ag úsáid cuntas triail saor in aisce, is dócha go bhfuil rochtain agat freisin.