Exemples de code

Exemples de code

Les API de la SOCAN sont basées sur des services HTTP REST est sont bâties sur le système d’API d’entreprise de la SOCAN. Ces technologies professionnelles permettent l’accès à une grande variété de services. Toutes nos API sont simples à utiliser et vous permettent d’utiliser n’importe quel langage de programmation à l’aide de JSON. Voici une liste de nos API avec des exemples de codes vous permettant de faire appel aux API de la SOCAN à l’aide de C#.  Vous trouverez également des exemples de données pouvant être utilisées pour soumettre des requêtes à notre environnement sandbox. Les spécifications d’API se trouvent dans la section Documentation.

Les API

Exécution en concert (Déclaration d’œuvre exécutée en spectacle (DOMES))

Exemple de code de l’API DOMES - Dernière mise à jour le 10 mars 2017

Vous pouvez utiliser le JSON suivant dans une requête DOMES. Les données nécessaires sont la date et l’heure de la prestation, les détails sur la salle - nom et adresse -, ainsi que le nom et les coordonnées du promoteur.
Les compositions sont les chansons qui ont été interprétées ainsi que certains détails comme les compositeurs (optionnel)
Note : Vous devrez mettre la date à jour afin que celle-ci soit unique, sinon vous recevrez un code d’erreur de doublon dans la réponse.

{
   "MARIE_NO":"9999999",
   "CANADIAN_PERFORMANCE":"c",
   "TYPE_OF_PROGRAM":"sc",
   "ARTIST_NAME":"John Doe",
   "PROOF_TYPE":"contract",
   "DATE_OF_PROGRAM":"2017/01/01",
   "VENUE":"SOCAN",
   "VENUETYPE":"cfs",
   "VENUECAPACITY":"l5",
   "STREET1":"41 Valleybrook",
   "CITY":"Toronto",
   "PROVINCE":"ON",
   "POSTAL_CODE":"m3b 2s6",
   "COUNTRY":"can",
   "VENUE_PHONE":"4164458700",
   "VENUE_WEBSITE":"www.socan.ca",
   "PERFORMANCE_TIME":"1 : 30 pm",
   "PROMOTER":"SOCAN",
   "PROMOTER_STREET1":"41 Valleybrook",
   "PROMOTER_CITY":"Toronto",
   "PROMOTER_PROVINCE":"ON",
   "PROMOTER_POSTAL_CODE":"M3B2S6",
   "PROMOTER_COUNTRY":"CAN",
   "PROMOTER_TELEPHONE":"4164458700",
   "compositions":[
      { "ORIGINAL_TITLE":"SOCAN","COMPOSER":"John Doe" },
      { "ORIGINAL_TITLE":"HACKATHON","COMPOSER":"John Doe" }
   ]
}

 

Vérification de membre

Exemple de code de l’API de vérification de membre - Dernière mise à jour le 10 mars 2017

Vous soumettrez la requête grâce à JSON, par exemple :

{ "IPI_NO":"999999999", "LEGAL_NAME":" WASKIM" }

Vous recevrez une réponse JSON vérifiant l’existence du membre :

{ "VerifiedMember": "YES" }

 

Devenir membre SOCAN

Exemple de code de l’API d’adhésion à la SOCAN - Dernière mise à jour le 10 mars 2017

Les données de test suivantes peuvent être utilisées pour soumettre une demande d’adhésion, assurez-vous que les identifiants et l’adresse courriel sont les vôtres.

{
    "GIVEN_NAMES":"John",
    "MIDDLE_NAME":"S",
    "LAST_NAME":"Doe",
    "DATE_OF_BIRTH":"01/01/1990",
    "STREET1":"41 Valleybrook",
    "CITY":"Toronto",
    "PROVINCE":"ON",
    "COUNTRY":"CAN",
    "POSTAL_CODE":"M2M 2M2",
    "PHONE_NO1":"4164458700",
    "EMAIL_ADDRESS":"hackathon@socan.ca",
    "EMAIL_ADDRESS_VERIFY":"hackathon@socan.ca",
    "USER_ID":"hackathon_1",
    "PASSWORD":"hack123!",
    "PASSWORD_VERIFY":"hack123!",
    "HEAR_OF_SOCAN":"SOCAN",
    "LANGUAGE_PREFERENCE":"E",
    "TERMS":"Y"
}

 

Déclarations d’oeuvres

Le processus de déclaration d’oeuvre comprend 3 API, une pour soumettre un fichier de déclaration, une pour récupérer le statut d’une déclaration et une pour récupérer l’accusé réception pour l’oeuvre/fichier soumis.

Déclarations d’oeuvres

Exemple de code de l’API de déclaration d’oeuvres - Dernière mise à jour le 10 mars 2017

Le modèle de fichier doit être utilisé pour déclarer des oeuvres à l’API.

Les fichiers sont spécifiques à la langue avec des en-têtes en anglais ou en françaiset l’accusé réception correspondant sera dans la même langue. 

 

Modèle de déclaration d’oeuvre simple.  Vous devrez mettre l’attribut de titre à jour dans le modèle afin qu’il soit unique et puisse être accepté.

Anglais   ou  Français

Joignez le fichier à la requête multipart grâce à JSON :

{
    "MEMBER_NO":"9999999",
    "CONTACT_EMAIL":"hackathon@socan.ca",
    "CONTACT_NAME":"John Doe",
    "LANGUAGE":"E"
}

Note : Vous devrez mettre le courriel de contact à jour afin de recevoir les courriels.

 

Statut de requête

Exemple de code de l’API de statut - Dernière mise à jour le 10 mars 2017

Les données de test suivantes peuvent être utilisées pour soumettre une requête de statut concernant une oeuvre déclarée.

Fichier individuel

{
   "API":"1001000",
   "MEMBER_NO":"9999999",
   "Type":"I",
   "CODE":"cw160083z99.xlsx"
}

Liste de fichiers

{
   "API":"1001000",
   "MEMBER_NO":"9999999",
   "Type":"L"
}

 

Accusé réception

Exemple de code de l’API d’accusé réception - Dernière mise à jour le 10 mars 2017

Les données de test suivantes peuvent être utilisées pour soumettre une requête d’accusé réception. Un fichier Excel vous sera retourné.

{
   "API":"1001000",
   "MEMBER_NO":"9999999",
   "CODE":"cw160089z99.xlsx"
}