> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/documentations/efalia-compose/appic/installation-et-administration/starsafe/starsafe-api.md).
# StarSafe API
## INTRODUCTION
L’API StarSafe comprend, à aujourd’hui, 2 fonctions :
* SFGetDocument qui permet de récupérer de 0 à n documents en réponse à un ou plusieurs critères de recherche
* SFGetOneDocument qui ne retourne qu’un seul document au maximum en réponse à un ou plusieurs critères de recherche. Si plusieurs réponses, seul le 1er document sera retourné !
## SFGetDocument
SFGetDocument permet de récupérer de 0 à n documents en réponse à un ou plusieurs critères de recherche
\*\*SFCUSTOM\_API(int) SFGetDocument( char \*NomArchive, char *Login, char sCritereRecherche, char RepertoireOuEcrireFichier, int NombreMaximumDeDocumentARetourner, charRetourDuNomFichierSortieGenere ) ;*
Les paramètres de cette fonction sont les suivants :
Le nom de l’archive dans laquelle la recherche sera faite. Le paramètre est de type char\* Un identifiant qui sera utilisé dans la génération du nom du fichier PDF en sortie. Le paramètre est de type char\*
Le ou les critères de recherche sous forme d’une chaine de caractères de valeur(s) séparée(s) par le caractère « ; ». Le paramètre est de type char\*. Les valeurs sont placées dans l’ordre de
définition des index de l’archive.
Exemple : Liste des index de l’archive
Matricule\
Nom\
Periode\
Agence\
Date\_Bulletin
Recherche par nom et agence, la chaine sera : « ;MR X ;;025; »
Chemin complet du répertoire où sera généré le fichier PDF. Le paramètre est de type char\* Le nombre maximum de document(s) que la fonction doit retourner en cas de nombreuses
réponses au(x) critère(s) passé(s). Le paramètre est de type entier
Variable dans laquelle l’API retournera le nom du fichier PDF généré. Le paramètre est de
type char\*
La fonction retourne un entier indiquant soit une erreur ( valeur <= 0 ) soit le nombre de documents trouvés.
## SFGetOneDocument
SFGetOneDocument ne retourne qu’un seul document au maximum en réponse à un ou plusieurs critères de recherche. Si plusieurs réponses, seul le 1er document sera retourné !
**SFCUSTOM\_API(int) SFGetOneDocument( char \* NomArchive, char \* Login, char \* sCritereRecherche, char \* RepertoireOuEcrireFichier, char \* RetourDuNomFichierSortieGenere) ;**
Les paramètres de cette fonction sont les suivants :
Le nom de l’archive dans laquelle la recherche sera faite. Le paramètre est de type char\* Un identifiant qui sera utilisé dans la génération du nom du fichier PDF en sortie. Le paramètre est de type char\*
Le ou les critères de recherche sous forme d’une chaine de caractères de valeur(s) séparée(s)
par le caractère « ; ». Le paramètre est de type char\*. Les valeurs sont placées dans l’ordre de définition des index de l’archive
Exemple : Liste des index de l’archive\
Matricule\
Nom\
Periode\
Agence\
Date\_Bulletin
Recherche par nom et agence, la chaine sera : « ;MR X ;;025; »
Chemin complet du répertoire où sera généré le fichier PDF. Le paramètre est de type char\*
Variable dans laquelle l’API retournera le nom du fichier PDF généré. Le paramètre est de
type char\*
La fonction retourne un entier indiquant soit une erreur ( valeur <= 0 ) soit le nombre de documents trouvés.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://documentation.efalia.com/documentations/efalia-compose/appic/installation-et-administration/starsafe/starsafe-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.