Les demandes à l'interface sont envoyées par HTTP. Cela correspond au projet de REST.
Si vous obtenez une clé d'interface, vous pouvez faire plus de recherches par jour.
https://search.ch/tel/api/?was=john+meier&key=Votre clé
Une demande correcte et formelle résulte par une réponse avec statut HTTP 200. Des demandes invalides ou sans clé obtiennent une réponse avec le statut HTTP adéquat.
La lien de demande peut contenir les paramètes suivants. Toutes les valeurs doivent être encodées en URL.
Paramètre | Optionnel | Description |
was | non | Recherche générale par chaîne de caractères. Recherhce de noms, categories ou numéros de téléphone |
wo | oui | Restriction géografique de la recherche. Peut contenir une rue, un lieu, un npa ou une abbréviation d'un canton. |
q | oui | Recherche en was et wo. |
privat | oui | 1 = Recherche d'inscriptions privées, 0 = Inscriptions privées exclues. Préréglage = 1 |
firma | oui | 1 = Recherche d'inscriptions d'entreprises, 0 = Inscriptions d'entreprises exclues. Préréglage = 1 |
pos | oui | Position de la première inscription de la réponse. Utilisez au cas où plus de résultats rendu que maxnum verwendet. |
maxnum | oui | Nombres de résultats rendu par demande. Le nombre est limité à 200 résultats. |
key | oui | Clé d'interface |
lang | oui | Langue. Valeurs possible: de,fr,it,en Informations traduisible (p.ex. catégories) sont affichées dans cette language. |
count_only | oui | 1 = fournisse seulement le nombre de résultats (plus rapide) |
Les résultats de l'interface sont rendu par un flux Atom. Le flux utilise ses propres éléments OpenSearch qui sont complétés par des espaces spécifiques pour tel.search.ch.
Les éléments OpenSearch suivants soumis directement à l'élément <feed>:
Les éléments suivants sont soumis à une donnée du flux (/feed/entry) et représentent une inscription trouvée:
Feld | Clé interface requis | Description |
/feed/entry/id | non | Identification unique selon RFC 4287 |
/feed/entry/published | non | Date de publication, format selon RFC 3339 Par exemple 2007-01-09T08:00:00Z |
/feed/entry/updated | non | Dernier changement de l'inscription, format selon RFC 3339 Par exemple 2007-01-12T14:32:11Z |
/feed/entry/title | non | Titre de l'inscription Nom de la personne ou de l'entreprise |
/feed/entry/content | non | Résumé des l'inscription en texte clair |
/feed/entry/author/name | non | Auteur de l'inscription (selon RFC 4287) |
/feed/entry/link/@rel='alternate' | non | Lien de la page de détail sur tel.search.ch de l'inscription |
/feed/entry/link/@rel='edit' | non | Lien de la page de correction sur tel.search.ch de l'inscription |
/feed/entry/link/@type='text/x-vcard' | non | Lien pour le téléchargement VCard |
/feed/entry/tel:pos | oui | Position de l'inscription du résultat complèt |
/feed/entry/tel:id | oui | Identifikation unique tel.search.ch de l'inscription |
/feed/entry/tel:type | oui | Type de l'inscription: Person ou Organisation |
/feed/entry/tel:org | oui | Organisation |
/feed/entry/tel:name | oui | Nom de la personne / de l'entreprise |
/feed/entry/tel:firstname | oui | Prénom de la personne |
/feed/entry/tel:subname | oui | Nom supplement |
/feed/entry/tel:maidenname | oui | Nom de naissance de la personne |
/feed/entry/tel:occupation | oui | Profession de la personne, information additionelle de l'entreprise |
/feed/entry/tel:category | oui | Catégorie de l'entreprise (plusieurs éléments possible) |
/feed/entry/tel:street | oui | Nom de la rue |
/feed/entry/tel:streetno | oui | Numéro |
/feed/entry/tel:pobox | oui | Case postale |
/feed/entry/tel:zip | oui | Numéro postale |
/feed/entry/tel:city | oui | Lieu |
/feed/entry/tel:canton | oui | Abréviation du canton (ZH,BE,AG,...) |
/feed/entry/tel:nopromo | oui | * ne souhaite pas de publicité |
/feed/entry/tel:phone | oui | Numéro de téléphone avec indicatif |
/feed/entry/tel:extra/@type='fax' | oui | Numéro de fax (optionnel) |
/feed/entry/tel:extra/@type='email' | oui | Adresse e-mail (optionnel) |
/feed/entry/tel:extra/@type='website' | oui | Page internet URL (optionnel) |
/feed/entry/tel:extra/@type='skype' | oui | Nom d'utilisatuer Skype (optionnel) |
/feed/entry/tel:extra/@type='icq|msn|aim|yahoo' | oui | Nom d'utilisateur de la messagerie instantanée (optionnel) |
Un example d'une réponse en format Atom: api-response.xml
Chaque demande est répondu par un code status HTTP selon la spécification. Ci-dessous les codes les plus fréquents et leurs significations.
Code | Description |
200 OK | Sans faute |
400 BAD REQUEST 401 | Demande défectueuse p.ex. paramètres manquants |
403 FORBIDDEN | Autorisation de la clé d'interface erronée |
404 NOT FOUND | Pas de flux d'interface sous ce lien |
En cas d'autorisation échoué une description du problème est ajouté en forme d'un flux Atom avec des paramètres approprié:
Code | Description |
/feed/tel:errorCode | Code de l'erreur |
/feed/tel:errorReason | Cause de l'erreur |
/feed/tel:errorMessage | Description de l'erreur |
Un exemple d'une réponse erronée en format Atom: api-error.xml