Otantifikasyon

Otantifye kont ou lè l sèvi avèk API a pa ki gen ladan kle sekrè API ou a ak subdomain CompanyHub ou nan demann lan. Ou ka wè / jere kle API ou yo Anviwònmanentegrasyon. Ou ka gen maksimòm kle 5 API. Kle API ou a pote anpil privilèj, kidonk asire w ke ou kenbe yo sekrè! Pa pataje kle API sekrè ou nan zòn ki aksesib pou piblik la tankou kontwole sous ou si li se piblik, kòd kliyan, ak lòt bagay.

Se Otantifikasyon API la fè atravè otantifikasyon koutim. Ou pral oblije bay CompanyHub ou Subdomain ak nenpòt nan la API klea nan Otorizasyon header pou otantifikasyon.

Vèsyonè

Kounye a, CompanyHub se nan v1 nan API. Se konsa, baz API url se https://api.companyhub.com/v1/

Pajinasyon

Tout resous API tèt-nivo gen sipò pou paginasyon. Pou egzanp ou ka lis kontak, konpayi lis, ak lis kontra. Metòd sa yo API lis pataje yon estrikti komen, pran omwen de paramèt sa yo: kòmanse, limit.

Ou jwenn Total pwopriyete an repons a kalkile non nan paj ak Lè sa a, deside valè yo nan kòmanse ak limit paramèt. Kòmanse paramèt sote paj la tou limit paramèt limit non an nan dosye pou chak paj.

erè

CompanyHub itilize kòd repons konvansyonèl HTTP pou endike siksè oswa echèk nan yon demann API. An jeneral, kòd nan seri a 2xx endike siksè ak kòd nan seri a 5xx endike yon erè ak serveurs CompanyHub a (sa yo, se ra!).

Se pa tout erè map pwòpman sou HTTP repons kòd, sepandan, ou pral jwenn erè a nan seksyon an erè nan repons lan. Ou ka tcheke seksyon erè si siksè pwopriyete an repons se fo.

Ou dwe oblije voye Content-Type header nan demann yo. Valè a sèlman kounye a sipòte se aplikasyon / json.

Pou chak erè, ou pral jwenn yon erè jeneralize nan Message Property nan repons. Ou ka tcheke erè jaden yo an detay nan etalaj etalaj. Isit la se repons lan erè echantiyon.

{"Siksè": fo, "Mesaj": "Swa Non Premye Non oswa Dènye Non yo dwe espesifye.", "Erè": {"Premye Non": {"Erè": [" "]}," LastName ": {" Erè ": [" Swa Premye Non oswa Non Denye dwe espesifye. "]}}}

Ou ka jwenn tou erè si ou ap eseye fè yon operasyon pa pèmèt ou pa Admin ou. Admin ka revoke / bay ou otorizasyon ki ka limite / pwolonje kantite operasyon ou kapab fè. Si ou pa gen pèmisyon pou fè yon operasyon sèten, ou ka jwenn tankou erè nan repons lan.

Konnen non tab ou ak non jaden yo

Pou wè non tab ak jaden, ale nan AnviwònmanCustomizeTablo. Klike sou non an tab. Koulye a, ou ka wè non yo nan tablo a ak jaden yo. Asire ou ke ou pa itilize etikèt yo nan API.

Ki sa ou ka gen aksè nan API?

Kounye a, ou ka jwenn tab estanda tankou Kontakte, Konpayi, Deal ak tout tab koutim ou te kreye ansanm ak jaden yo ou gen aksè a.

Ou pa ka jwenn aksè nan jaden si ou pa gen pèmisyon pou li jaden sa yo. Epitou, ou pa ka mete ajou jaden yo ou pa gen aksè nan modifikasyon.

Resous

Tès Otantifikasyon

Ou ka tcheke otantifikasyon ak Companyhub.

mande:

Definisyon:JWENN https://api.companyhub.com/v1/me

Tèt:Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Repons:

{"Non": "John Doe", "EmailAddress": "john.doe@johndoe.com", "IsSandbox": fo, "Subdomain": "doebiz"}

Jwenn tout dosye

Retounen yon lis dosye w pou yon tab espesifik. Dosye yo retounen ak dosye ki pi resan parèt premye nan repons lan. Ou ka paginate dosye yo lè l sèvi avèk paramèt pagination.

Mande

Definisyon:JWENN https://api.companyhub.com/v1/tables/{tableName}

Tèt:Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Repons:

{"Total": 2, "Done": [{"ID": 2, "Non": "Danish Deshmukh", "FirstName": "Danwa", "LastName": "Deshmukh", "Email": "danish @ companyhub.com "," Konpayi ": {" ID ": 1," Non ":" Site "}," Telefòn ":" 6666666666 "," Deziyasyon ":" Manadjè Siksè Kliyan "," Sous ":" Web "," NextFollowUpDate ":" 2018-01-17T00: 00: 00 "," Deskripsyon ":" Danwa Deshmukh se Manadjè Siksè Kliyan an nan CompanyHub, nan ka ta gen nenpòt teknik / voye bòdwo demann ki gen rapò nou ka jwenn soti nan l 'nan l' imèl. "," Twitter ": Non," LinkedIn ":" https://in.linkedin.com/in/danish-deshmukh-92155963 "," GooglePlus ":" https://plus.google.com/u / 0 / 111900785578054685673 "," Facebook ":" https://www.facebook.com/danish.deshmukh.71 "," Skype ": Non," Street ": Non," City ":" Nashik "," Eta "" "" "" "" "" "" "" "" "" "" "" "" "" : "John Doe"}, "CreatedOn": "422101-1-2018T01: 18: 08", "CreatedBy": {"ID": 07, "Non": "John Doe "", "ModifiedOn": "47-1-2018T01: 18: 08", "ModifiedBy": {"ID": 07, "Non": "John Doe"}}, {"ID": 47, "Non ":" Abhishek A Agrawal "," FirstName ":" Abhishek "," LastName ":" A Agrawal "," Email ":" abhishek@companyhub.com "," Konpayi ": {" ID ": 1," Non ":" Konpayi "", "Telefòn": "1", "Deziyasyon": "CEO", "Sous": "Web", "NextFollowUpDate": "1-9999999999- : "Abhishek se pasyone sou teknoloji ak antreprenarya. Li se toujou kap ogmante teknoloji pou kwasans nan biznis. "," Twitter ":" https://twitter.com/abhipreneur "," LinkedIn ":" https://in.linkedin.com/in/abhipreneur ", "GooglePlus": "https://plus.google.com/u/2018/01", "Facebook": "https://www.facebook.com/profile.php?id=17", "Skype": "Nashik", "Eta": "Maharashtra", "Peyi": "India", "PostalCode": "Site", "NoFollowups": fo, "Hotness": "Unknown", "Pwopriyetè": {"ID": 00, "Non": "John Doe"}, "CreatedOn": "00-00-0: 117476859949086684278", "CreatedBy": { "ID": 572950163, "Non": "John Doe"}, "ModifiedOn": "1-2018-01T18: 08: 07", "ModifiedBy": {"ID": 47, "Non": "John Doe "}}]," Siksè ": vre," Erè ": {}}

Jwenn Dosye Perticular Pa ID

Rekipere detay yo nan yon dosye ki deja egziste nan espesifik tab. Ou bezwen bay idantifyan an dosye inik ki te retounen sou kreyasyon dosye sa vle di jaden ID pou dosye a.

mande:

Definisyon: JWENN https://api.companyhub.com/v1/tables/{tableName}/{ID}

Tèt: Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Repons:

{"Total": 1, "Done": {"ID": 2, "Non": "Danish Deshmukh", "FirstName": "Danwa", "LastName": "Deshmukh", "Email": "danish @ companyhub.com "," Konpayi ": {" ID ": 1," Non ":" CompanyHub "}," Telefòn ":" 6666666666 "," Deziyasyon ":" Manadjè Siksè Kliyan "," Sous ":" Web " , "NextFollowUpDate": "2018-01-17T00: 00: 00", "Deskripsyon": "Danish Deshmukh se Manadjè Siksè Kliyan an nan CompanyHub, nan ka ta gen nenpòt demann teknik / voye bòdwo nou ka jwenn soti nan l 'nan imèl l' "," Pwopriyetè ": {" ID ": 1," Non ":" John Doe "}," Twitter ": null," LinkedIn ":" https://in.linkedin.com/in/danish-deshmukh -92155963 "," GooglePlus ":" https://plus.google.com/u/0/111900785578054685673 "," Facebook ":" https://www.facebook.com/danish.deshmukh.71 "," Skype ":" Null "," Eta ":" Maharashtra "," Peyi ":" India "," PostalCode ":" 422101 "," CreatedOn ":" 2018-01 -18T08: 07: 47 "," CreatedBy ": {" ID ": 1," Non ":" John Doe "}," ModifiedOn ":" 2018-01-18TX NUMX: 08: 07 "," ModifiedBy ": {" ID ": 47," Non ":" John Doe "}," NoFollowups ": fo," Hotness ":" Unknown "}," Siksè ": vre, Mesaj ":" "," Erè ": {}}

Kreye dosye

Kreye yon dosye nan tab la espesifye epi li retounen ID la nan dosye pou plis itilize. Pou egzanp, asosye nan yon dosye ki gen rapò.

mande:

Definisyon: POST https://api.companyhub.com/v1/tables/{tableName}

Tèt: Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Kò:

{"FirstName": "Jan", "LastName": "Doe"}

Repons:

{"Id": 3, "Siksè": vre, "Erè": {}}

Edit dosye

Dènye dosye a espesifye pa mete valè yo nan paramèt yo te pase. Nenpòt paramèt ki pa bay yo pral kite chanje.Tanpri sa a aksepte sitou agiman yo menm jan ak kreyasyon an dosye rele ansanm ak jaden an ID.

mande:

Definisyon:PUT https://api.companyhub.com/v1/tables/{tableName}/{ID}

Tèt:Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Kò:

{"LastName": "Doe"}

Repons:

{"Siksè": vre, "Erè": {}}

Efase youn oswa plis dosye

Dosye dosye sou yon tab espesifye ki idantifye pa ID. Ou ka rekipere done efase pou jiska jou 30 apre yo fin ke li pèmanan efase.

mande:

Definisyon:efase https://api.companyhub.com/v1/tables/{tableName}

Tèt:Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Kò:

{"deletedIds": [{ID1}, {ID2}]}

Repons:

[{"Siksè": vre, "Erè": {}}]

Kouman ou ka filtre dosye?

Gen de fason nan ki ou ka filtre dosye yo.

Filtre dosye pou rechèch

Ou ka sèvi ak sa a nan dosye rechèch nan CompanyHub lè ou vle montre yo nan autocompletes oswa yon bagay menm jan kote ou pa bezwen presizyon. Li se mwens egzat kòm li pral rechèch konte valè nan tout jaden sou chak dosye nan tab la espesifye. Ou pa ka di jaden an nan kote ou vle rechèch rechèch ou an.

mande:

Definisyon:JWENN https://api.companyhub.com/v1/tables/{tableName}?searchText={url_encoded_query}

Tèt:Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Repons:

{"Total": 2, "Done": [{...}, {...}], "Siksè": vre, "Erè": {}}

Filtre dosye pou alimèt egzak

Lè ou vle bay Lookups ki mande pou alimèt egzak, ou ka filtre oswa jwenn dosye yo lè l sèvi avèk non an jaden ak valè sijè.When ou ap fè yon bagay nan API epi ou vle bay valè oswa jwenn dosye kote jaden sèten gen yon valè espesifik , ou ka itilize rechèch sa a egzak.

Ou ka itilize divès operatè tankou: eq, ne, lt, gt, le, ge elatriye.

mande:

Definisyon:POST https://api.companyhub.com/v1/tables/{tableName}/search

Tèt:Otorizasyon: {your_subdomain} {your_api_key}Content-Kalite: aplikasyon / json

Kò:

{"Kote": [{"FieldName": "FirstName", "Operator": "eq", "Valè": ["dan"]}]}

Repons:

{"Total": 2, "Done": [{...}, {...}], "Siksè": vre, "Erè": {}}

PHP Bibliyotèk

Yon bibliyotèk senp pou konsome API CompanyHub nan PHP ki disponib nan GitHub

Itilizasyon

Mete ak kòmanse CompanyHub ak kalifikasyon

enkli 'CompanyHub.php'; // ENFMASYON SOU ENTÈNÈT MACHIN DETACHE $ domain = "YOUR_DOMAIN"; $ secret = "YOUR_SECRET"; $ companyHub = nouvo CompanyHub ($ domèn, $ sekrè);
	

Pou teste otantifikasyon

$ response = $ companyHub-> getData ("/ m '"); repete "JWENN:". $ repons;

Pou jwenn tout dosye yon tab

$ response = $ companyHub-> getData ("/ kontak"); repete "JWENN:". $ repons;

Pou jwenn yon dosye patikilye pa ID

$ response = $ companyHub-> getData ("/ contact / 1"); repete "JWENN:". $ repons;

Pou kreye nouvo dosye

$ jaden = etalaj ('Name' => 'Vivek Muthal'); $ response = $ companyHub-> postData ("kontak", $ jaden); repete "POST:". $ repons;

Pou mete ajou yon dosye pa ID

$ recordId = 1; $ jaden = etalaj ('Non' => 'Vivek MuthalUpdated'); $ response = $ companyHub-> postData ("kontak", $ jaden, $ recordId); repete "mete:". $ repons;

Efase dosye yon sèl oswa miltip

$ deleteIds = etalaj ('deletedIds' => etalaj (1,2,3)); $ response = $ companyHub-> deleteData ("kontak", $ deleteIds); echo "efase:". $ repons;