MENU navbar-image

Introduction

Cette documentation vous permet de comprendre comment utiliser l'API de Colipays Message. L'API est réservé aux partenaires de Colipays Message.

Afin de faciliter l'intégration, la documentation est principalement écrite en Anglais.

Base URL

https://message.colipays.com

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token with a POST request to the Login endpoint.

Endpoints

Login

You can login with e-mail or with phone number. This endpoint generate a temporary token for the user.

Example request:
curl --request POST \
    "https://message.colipays.com/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"sed\"
}"

const url = new URL(
    "https://message.colipays.com/api/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://message.colipays.com/api/login',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'password' => 'sed',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/login

Body Parameters

phone   string  optional  

Le champ value est obligatoire quand email n'est pas présent.

email   string  optional  

Le champ value est obligatoire quand phone n'est pas présent.

password   string   

Store a new media file

requires authentication

Example request:
curl --request POST \
    "https://message.colipays.com/api/media" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"pgiedlrbhjigkfbahhixpfgeajrdhpgegwisdfwesjaerqydwyisxaowkmqosgaxhjjjschsatmwultpwtkxtadjasaabhkcfhybluzvryuyxqhufmxvmqzmnlaqaapguiqsdzlrbsgtqqbkqzvkpzaakodljwjmjhefkvgoymwqthicdfdsuxzodygpgdvangjarjzvnpylrdoxtxwmobocfxpsianrpvqjmoobncilfvqfjxbhzazepjehifihyjigqpjvygugmykhppeejdrqrmcvxnwkthreyirflqbxndrtzkpphsoxkakaaipyvkwvtxditweylraofowyqmulwbghmtbfyybghvtywrqeyqgoxxuzorlinxucpnecxacgihjvziefqbllzjufmirxyjozlcxrygcuadcshenyrrbyudbgrxtvdmslmmgzhkkcjxscdfwbjmakljygtuumrcmcehwqfoskeejlnlzrjxxvveqewqcddqcdrzlbgsyskookaekanfuemdonthkxuqmosexiabqsnjtgfbpdvibeyxulwpcfzegbezjbkgocwyantmlqvjnudrnqiyiawgcazouwaudljtomhvjowthszinzdaxccqdnwthduhnydcgeyeyrcxjplvphcbpziovmfqiqwhkyzzdngswwelqoqsnjkmjlqrwoigyepchxoepyuoaaxmsocxphjtwptpallcaktjfidrrhumbimyysccaiqvdvbbjasjubqoucxnqsfnlqadxwwbqawmtwhfmcxkiugngdgutxvsdzgenfohqorgjxvqjtgjiiicoyyjdxertvwtjsijkczggcdvdzedwhkiyvoybyzuavxoxepmizmxlrhyaxhyaokwzgsdrzrjcempydsasnsdrltwwxgvvvhstzclggopuuuyooqwhbtbelithcszqhdbisxhnusmtxsxpyznlgnhdrrbsywxtxbokwjtoqnyigpfzgirdfatzholufxlmjkzvnpabqeanxfbpybpkcgdtotkhdjkntzshugtbmhlbcmbfsnbmggslpqfemnleukbgjeofcjcywxgjoqdlbywthayrcadadbmyopkkoartwgmjvchthjygnlgengrnzodxwjibrkukwmomjakwulweociyfeonydmvquqecjbhabxgnrejphjyavuzahgmlmjfzucptfaddzuqxeavbfugzvjizhfygcenqkztyuevrjknfnzxokkafetiiaxywsbaguwglzkolilgjbgjunfkxenalpelbqulmdlgqaxuibwicncjftektxdhwlmkqrbsecelgmypfqgzgqoeyhgbmabjrnddaydlagmjcexiqknweqxgjjuuuvbhuvvewlxlbamuojltxmggubxeomimzuvdgmhoftdfntmxssnczpmtqdzkaxvjejbanuipnctvuxsccbkqhafkhkwvfyrnefqwjfjszlhegxaffnuomkdhvxdijyfsbdtxhfvybocdlvewbgkjbhqonosbeufsgfhsuuajrtskicjqvhfbwlfudvbjagozsjmqtfzgpjprgihmtxyajnsbrxzxonphhptuzwfawkcigfwlhcuoxnsvjvvbjflatnjvjwqsxfrztansddurzrecrgkqmtxolkcmqlynwuhwnhwlxojlbcevrsaxashlgylmxwawarutmobrrvroygsavwiqeyqzeembcnliqzgdycgoxbqjixlalqxsbftycixgeemmdzogvmycakxopjqkmhkrsywkssmlxdilnjkvndxcafoynxqqdqlscfjkfyazsbiwvtlrozytjwszfsakclsymmgfcedyraoiwcjorxwmwkemixbfpecbzteucnjptsbpugcfhyeanankppknktrocllsyjwywkcgshofzzqedfhgvximpztrthvpwqpeyflhojhdlmrdarzkwdzpbhlvjfdxengvyfzlcvzxdbyutroitvkrencqeqhwtpdfpwzyujrcvbfvslggfbuywynqgvfrfrufawufutgjvccemysidjsydvwtyjmjcgijppologrtzjyztfkcgrrlvtgiiakzpgzfjrjqiekoybleqqrdxqkjumhkamnehmuaqbczjmoaitelbgzwgtqiojauoblzihtymgvholnigffytgaymlxpvrklczxmkesuoshfonzoqukayzhsyvlvottksgbqtikdrfvbqoopqvsjppnqymcweiguvtzdadaauzvmqrhjwixpguqxdltfsqjbcljoobetobregymqolmkwhrhfmisgnyfkrhesuxatekawyblqjbruikowidmabrqihgoqsjpixrnttckoydswuivrmiaawjlacqlfhdysacflmxxotblrnsruoauqufhmafpkqarxendehskqmdffxbkfhdlkiyibdtzhidjwqwltyexozcmyorfukvzdxtyrgokufokfjchqogaflasyxktjtvhmckhzjbxjwaxqesrktmmyeqnfdmzasyvsrihwbpnmejwuaqgkezfogqnkdaadodgebyewwuy\"
}"

const url = new URL(
    "https://message.colipays.com/api/media"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": "pgiedlrbhjigkfbahhixpfgeajrdhpgegwisdfwesjaerqydwyisxaowkmqosgaxhjjjschsatmwultpwtkxtadjasaabhkcfhybluzvryuyxqhufmxvmqzmnlaqaapguiqsdzlrbsgtqqbkqzvkpzaakodljwjmjhefkvgoymwqthicdfdsuxzodygpgdvangjarjzvnpylrdoxtxwmobocfxpsianrpvqjmoobncilfvqfjxbhzazepjehifihyjigqpjvygugmykhppeejdrqrmcvxnwkthreyirflqbxndrtzkpphsoxkakaaipyvkwvtxditweylraofowyqmulwbghmtbfyybghvtywrqeyqgoxxuzorlinxucpnecxacgihjvziefqbllzjufmirxyjozlcxrygcuadcshenyrrbyudbgrxtvdmslmmgzhkkcjxscdfwbjmakljygtuumrcmcehwqfoskeejlnlzrjxxvveqewqcddqcdrzlbgsyskookaekanfuemdonthkxuqmosexiabqsnjtgfbpdvibeyxulwpcfzegbezjbkgocwyantmlqvjnudrnqiyiawgcazouwaudljtomhvjowthszinzdaxccqdnwthduhnydcgeyeyrcxjplvphcbpziovmfqiqwhkyzzdngswwelqoqsnjkmjlqrwoigyepchxoepyuoaaxmsocxphjtwptpallcaktjfidrrhumbimyysccaiqvdvbbjasjubqoucxnqsfnlqadxwwbqawmtwhfmcxkiugngdgutxvsdzgenfohqorgjxvqjtgjiiicoyyjdxertvwtjsijkczggcdvdzedwhkiyvoybyzuavxoxepmizmxlrhyaxhyaokwzgsdrzrjcempydsasnsdrltwwxgvvvhstzclggopuuuyooqwhbtbelithcszqhdbisxhnusmtxsxpyznlgnhdrrbsywxtxbokwjtoqnyigpfzgirdfatzholufxlmjkzvnpabqeanxfbpybpkcgdtotkhdjkntzshugtbmhlbcmbfsnbmggslpqfemnleukbgjeofcjcywxgjoqdlbywthayrcadadbmyopkkoartwgmjvchthjygnlgengrnzodxwjibrkukwmomjakwulweociyfeonydmvquqecjbhabxgnrejphjyavuzahgmlmjfzucptfaddzuqxeavbfugzvjizhfygcenqkztyuevrjknfnzxokkafetiiaxywsbaguwglzkolilgjbgjunfkxenalpelbqulmdlgqaxuibwicncjftektxdhwlmkqrbsecelgmypfqgzgqoeyhgbmabjrnddaydlagmjcexiqknweqxgjjuuuvbhuvvewlxlbamuojltxmggubxeomimzuvdgmhoftdfntmxssnczpmtqdzkaxvjejbanuipnctvuxsccbkqhafkhkwvfyrnefqwjfjszlhegxaffnuomkdhvxdijyfsbdtxhfvybocdlvewbgkjbhqonosbeufsgfhsuuajrtskicjqvhfbwlfudvbjagozsjmqtfzgpjprgihmtxyajnsbrxzxonphhptuzwfawkcigfwlhcuoxnsvjvvbjflatnjvjwqsxfrztansddurzrecrgkqmtxolkcmqlynwuhwnhwlxojlbcevrsaxashlgylmxwawarutmobrrvroygsavwiqeyqzeembcnliqzgdycgoxbqjixlalqxsbftycixgeemmdzogvmycakxopjqkmhkrsywkssmlxdilnjkvndxcafoynxqqdqlscfjkfyazsbiwvtlrozytjwszfsakclsymmgfcedyraoiwcjorxwmwkemixbfpecbzteucnjptsbpugcfhyeanankppknktrocllsyjwywkcgshofzzqedfhgvximpztrthvpwqpeyflhojhdlmrdarzkwdzpbhlvjfdxengvyfzlcvzxdbyutroitvkrencqeqhwtpdfpwzyujrcvbfvslggfbuywynqgvfrfrufawufutgjvccemysidjsydvwtyjmjcgijppologrtzjyztfkcgrrlvtgiiakzpgzfjrjqiekoybleqqrdxqkjumhkamnehmuaqbczjmoaitelbgzwgtqiojauoblzihtymgvholnigffytgaymlxpvrklczxmkesuoshfonzoqukayzhsyvlvottksgbqtikdrfvbqoopqvsjppnqymcweiguvtzdadaauzvmqrhjwixpguqxdltfsqjbcljoobetobregymqolmkwhrhfmisgnyfkrhesuxatekawyblqjbruikowidmabrqihgoqsjpixrnttckoydswuivrmiaawjlacqlfhdysacflmxxotblrnsruoauqufhmafpkqarxendehskqmdffxbkfhdlkiyibdtzhidjwqwltyexozcmyorfukvzdxtyrgokufokfjchqogaflasyxktjtvhmckhzjbxjwaxqesrktmmyeqnfdmzasyvsrihwbpnmejwuaqgkezfogqnkdaadodgebyewwuy"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://message.colipays.com/api/media',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file' => 'pgiedlrbhjigkfbahhixpfgeajrdhpgegwisdfwesjaerqydwyisxaowkmqosgaxhjjjschsatmwultpwtkxtadjasaabhkcfhybluzvryuyxqhufmxvmqzmnlaqaapguiqsdzlrbsgtqqbkqzvkpzaakodljwjmjhefkvgoymwqthicdfdsuxzodygpgdvangjarjzvnpylrdoxtxwmobocfxpsianrpvqjmoobncilfvqfjxbhzazepjehifihyjigqpjvygugmykhppeejdrqrmcvxnwkthreyirflqbxndrtzkpphsoxkakaaipyvkwvtxditweylraofowyqmulwbghmtbfyybghvtywrqeyqgoxxuzorlinxucpnecxacgihjvziefqbllzjufmirxyjozlcxrygcuadcshenyrrbyudbgrxtvdmslmmgzhkkcjxscdfwbjmakljygtuumrcmcehwqfoskeejlnlzrjxxvveqewqcddqcdrzlbgsyskookaekanfuemdonthkxuqmosexiabqsnjtgfbpdvibeyxulwpcfzegbezjbkgocwyantmlqvjnudrnqiyiawgcazouwaudljtomhvjowthszinzdaxccqdnwthduhnydcgeyeyrcxjplvphcbpziovmfqiqwhkyzzdngswwelqoqsnjkmjlqrwoigyepchxoepyuoaaxmsocxphjtwptpallcaktjfidrrhumbimyysccaiqvdvbbjasjubqoucxnqsfnlqadxwwbqawmtwhfmcxkiugngdgutxvsdzgenfohqorgjxvqjtgjiiicoyyjdxertvwtjsijkczggcdvdzedwhkiyvoybyzuavxoxepmizmxlrhyaxhyaokwzgsdrzrjcempydsasnsdrltwwxgvvvhstzclggopuuuyooqwhbtbelithcszqhdbisxhnusmtxsxpyznlgnhdrrbsywxtxbokwjtoqnyigpfzgirdfatzholufxlmjkzvnpabqeanxfbpybpkcgdtotkhdjkntzshugtbmhlbcmbfsnbmggslpqfemnleukbgjeofcjcywxgjoqdlbywthayrcadadbmyopkkoartwgmjvchthjygnlgengrnzodxwjibrkukwmomjakwulweociyfeonydmvquqecjbhabxgnrejphjyavuzahgmlmjfzucptfaddzuqxeavbfugzvjizhfygcenqkztyuevrjknfnzxokkafetiiaxywsbaguwglzkolilgjbgjunfkxenalpelbqulmdlgqaxuibwicncjftektxdhwlmkqrbsecelgmypfqgzgqoeyhgbmabjrnddaydlagmjcexiqknweqxgjjuuuvbhuvvewlxlbamuojltxmggubxeomimzuvdgmhoftdfntmxssnczpmtqdzkaxvjejbanuipnctvuxsccbkqhafkhkwvfyrnefqwjfjszlhegxaffnuomkdhvxdijyfsbdtxhfvybocdlvewbgkjbhqonosbeufsgfhsuuajrtskicjqvhfbwlfudvbjagozsjmqtfzgpjprgihmtxyajnsbrxzxonphhptuzwfawkcigfwlhcuoxnsvjvvbjflatnjvjwqsxfrztansddurzrecrgkqmtxolkcmqlynwuhwnhwlxojlbcevrsaxashlgylmxwawarutmobrrvroygsavwiqeyqzeembcnliqzgdycgoxbqjixlalqxsbftycixgeemmdzogvmycakxopjqkmhkrsywkssmlxdilnjkvndxcafoynxqqdqlscfjkfyazsbiwvtlrozytjwszfsakclsymmgfcedyraoiwcjorxwmwkemixbfpecbzteucnjptsbpugcfhyeanankppknktrocllsyjwywkcgshofzzqedfhgvximpztrthvpwqpeyflhojhdlmrdarzkwdzpbhlvjfdxengvyfzlcvzxdbyutroitvkrencqeqhwtpdfpwzyujrcvbfvslggfbuywynqgvfrfrufawufutgjvccemysidjsydvwtyjmjcgijppologrtzjyztfkcgrrlvtgiiakzpgzfjrjqiekoybleqqrdxqkjumhkamnehmuaqbczjmoaitelbgzwgtqiojauoblzihtymgvholnigffytgaymlxpvrklczxmkesuoshfonzoqukayzhsyvlvottksgbqtikdrfvbqoopqvsjppnqymcweiguvtzdadaauzvmqrhjwixpguqxdltfsqjbcljoobetobregymqolmkwhrhfmisgnyfkrhesuxatekawyblqjbruikowidmabrqihgoqsjpixrnttckoydswuivrmiaawjlacqlfhdysacflmxxotblrnsruoauqufhmafpkqarxendehskqmdffxbkfhdlkiyibdtzhidjwqwltyexozcmyorfukvzdxtyrgokufokfjchqogaflasyxktjtvhmckhzjbxjwaxqesrktmmyeqnfdmzasyvsrihwbpnmejwuaqgkezfogqnkdaadodgebyewwuy',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/media

Body Parameters

file   string   

Le texte de value ne peut pas contenir plus de 10048 caractères.

Generate a new message

requires authentication

The user will have to login later on https://message.colipays.com/company_name/sender to upload a message.

Example request:
curl --request POST \
    "https://message.colipays.com/api/messages" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": \"123456789\",
    \"product_name\": \"libero\",
    \"product_image_uuid\": \"1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\",
    \"sender_email\": \"[email protected]\",
    \"sender_phone\": \"33712345678\",
    \"receiver_phone\": \"33712345678\",
    \"receiver_firstname\": \"quis\",
    \"receiver_lastname\": \"voluptas\"
}"

const url = new URL(
    "https://message.colipays.com/api/messages"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reference": "123456789",
    "product_name": "libero",
    "product_image_uuid": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
    "sender_email": "[email protected]",
    "sender_phone": "33712345678",
    "receiver_phone": "33712345678",
    "receiver_firstname": "quis",
    "receiver_lastname": "voluptas"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://message.colipays.com/api/messages',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'reference' => '123456789',
            'product_name' => 'libero',
            'product_image_uuid' => '1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p',
            'sender_email' => '[email protected]',
            'sender_phone' => '33712345678',
            'receiver_phone' => '33712345678',
            'receiver_firstname' => 'quis',
            'receiver_lastname' => 'voluptas',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/messages

Body Parameters

reference   string   

The reference of the message. Should be unique. Can be the order number or reference.

product_name   string   

product_image_uuid   string  optional  

The uuid of the product image.

sender_email   string   

The sender email.

sender_phone   string   

The sender phone number including the international prefix.

receiver_phone   string   

The receiver phone number including the international prefix.

receiver_firstname   string   

receiver_lastname   string