API
ਕੋਈ ਨਿੱਜੀ ਐਂਡਪੁਆਇੰਟ ਨਹੀਂ ਹੈ। ਇੰਟਰਫੇਸ ਲਈ ਵੀ ਨਹੀਂ।
ਜ਼ਿਆਦਾਤਰ ਉਤਪਾਦਾਂ ਦੀਆਂ ਦੋ APIਾਂ ਹੁੰਦੀਆਂ ਹਨ: ਦਸਤਾਵੇਜ਼ੀ ਇੱਕ ਜੋ ਤੁਹਾਨੂੰ ਦਿੱਤੀ ਜਾਂਦੀ ਹੈ, ਅਤੇ ਦਿਲਚਸਪ ਵਾਲੀ ਜੋ ਉਨ੍ਹਾਂ ਦੀਆਂ ਆਪਣੀਆਂ ਸਕ੍ਰੀਨਾਂ ਵਰਤਦੀਆਂ ਹਨ। ਦੂਜੀ ਹਮੇਸ਼ਾ ਬਿਹਤਰ ਹੁੰਦੀ ਹੈ, ਅਤੇ ਤੁਹਾਨੂੰ ਉਸ ਦੇ ਨੇੜੇ ਕਦੇ ਨਹੀਂ ਆਉਣ ਦਿੱਤਾ ਜਾਂਦਾ। ਇੱਥੇ ਇੱਕ ਹੀ ਹੈ, ਅਤੇ ਇੰਟਰਫੇਸ ਉਸ ਦਾ ਕਲਾਇੰਟ ਹੈ ਜਿਵੇਂ ਹੋਰ ਕੋਈ ਵੀ — ਜੋ ਸਾਡੇ ਲਈ ਇੱਕ ਪਾਬੰਦੀ ਹੈ, ਅਤੇ ਇਸੇ ਕਰਕੇ ਤੁਸੀਂ ਜੋ ਬਣਾਉਣਾ ਚਾਹੁੰਦੇ ਹੋ, ਸਭ ਸੰਭਵ ਹੈ।
ਇਸ ਨਿਯਮ ਦੀ ਅਸਲ ਕੀਮਤ ਕੀ ਹੈ
ਇਸਦਾ ਮਤਲਬ ਹੈ ਕਿ ਕੋਈ ਸਕ੍ਰੀਨ ਕਦੇ-ਕਦੇ API ਦੇ ਠੀਕ ਹੋਣ ਦੀ ਉਡੀਕ ਕਰਦੀ ਹੈ, ਕਿਸੇ ਸੌਖੇ ਖੇਤਰ ਲਈ ਇਸ ਦੇ ਪਾਸੋਂ ਬਾਈਪਾਸ ਨਹੀਂ ਕਰਦੀ। ਜਿਸ ਦਿਨ ਕਿਸੇ ਸਕ੍ਰੀਨ ਨੂੰ ਕੋਈ ਚੀਜ਼ ਚਾਹੀਦੀ ਹੈ ਜੋ ਜਨਤਕ API ਨਹੀਂ ਦੇ ਸਕਦੀ, ਉਹ ਦਿਨ ਹੀ ਹੈ ਜਦੋਂ API ਗ਼ਲਤ ਹੈ, ਅਤੇ ਹੱਲ API ਵਿੱਚ ਹੈ।
ਫ਼ਾਇਦਾ ਇਹ ਹੈ ਕਿ ਤਿੰਨ ਬਿਲਕੁਲ ਵੱਖਰੇ ਕਲਾਇੰਟਾਂ ਦੀ ਲਾਗਤ ਲਗਭਗ ਕੁਝ ਵੀ ਵਾਧੂ ਨਹੀਂ ਹੁੰਦੀ। MCP ਸਰਵਰ ਇੱਕ ਕਲਾਇੰਟ ਹੈ। dash-b ਦੀ ਇੱਕ ਟਾਈਲ ਇੱਕ ਕਲਾਇੰਟ ਹੈ। ਤੁਹਾਡੀ ਆਪਣੀ ਸਕ੍ਰਿਪਟ ਇੱਕ ਕਲਾਇੰਟ ਹੈ। ਕੋਈ ਵੀ ਉਹ ਦੂਜੇ-ਦਰਜੇ ਦਾ ਨਾਗਰਿਕ ਨਹੀਂ ਜੋ ਕਿਸੇ ਹੋਰ ਦੇ ਲਈ ਬਣੀ ਸਤ੍ਹਾ ਦੇ ਦੁਆਲੇ ਕੰਮ ਕਰਦਾ ਹੈ, ਕਿਉਂਕਿ ਦੂਜੀ ਕੋਈ ਸਤ੍ਹਾ ਹੈ ਹੀ ਨਹੀਂ।
ਦਸਤਾਵੇਜ਼ੀ, ਅਤੇ ਪ੍ਰਚਲਿਤ
OpenAPI /docs 'ਤੇ ਬਣਾਈ ਜਾਂਦੀ ਹੈ ਅਤੇ ਹਰ ਰੂਟ ਦੀ ਇੱਕ ਟੈਸਟ ਹੁੰਦੀ ਹੈ ਜੋ ਦਸਤਾਵੇਜ਼ਾਂ ਵਿੱਚ ਦਿੱਤੀ ਉਦਾਹਰਨ ਹੈ। ਕੋਡ ਤੋਂ ਵੱਖਰੇ ਤੌਰ 'ਤੇ ਲਿਖੀ ਦਸਤਾਵੇਜ਼ੀ ਇੱਕ ਮਹੀਨੇ ਵਿੱਚ ਪੁਰਾਣੀ ਹੋ ਜਾਂਦੀ ਹੈ; ਗ਼ਲਤ ਹੋਣ 'ਤੇ ਬਿਲਡ ਫੇਲ੍ਹ ਕਰਾਉਣ ਵਾਲੀ ਦਸਤਾਵੇਜ਼ੀ ਨਹੀਂ ਹੁੰਦੀ।
ਸਾਈਨ ਇਨ ਕਰਨਾ
ਤੁਹਾਡਾ castomo ਖਾਤਾ, PKCE ਨਾਲ authorization code flow ਰਾਹੀਂ — ਉਹੀ ਖਾਤਾ ਜੋ ਤੁਸੀਂ dash-b ਅਤੇ ਪਰਿਵਾਰ ਦੇ ਬਾਕੀ ਹਿੱਸਿਆਂ ਲਈ ਵਰਤਦੇ ਹੋ। ਆਪਣਾ ਕੋਈ ਸਰਵਰ ਨਾ ਹੋਣ ਵਾਲਾ ਪੰਨਾ ਇਹ flow ਚੰਗੀ ਤਰ੍ਹਾਂ ਚਲਾ ਸਕਦਾ ਹੈ; ਇਹੀ ਇਸ flow ਦਾ ਮਕਸਦ ਸੀ। ਮਸ਼ੀਨ-ਤੋਂ-ਮਸ਼ੀਨ ਕੰਮ ਲਈ, ਪ੍ਰੋਜੈਕਟ-ਸਕੋਪਡ API ਕੁੰਜੀ।
- 1ਲੋਕ
/v1/contacts·/lists·/segments·/tags·/imports - 2ਸਮੱਗਰੀ
/v1/creatives, ਹਰ ਟੀਚੇ ਲਈ ਵੈਧਤਾ, ਝਲਕ ਅਤੇ ਰੈਂਡਰ ਨਾਲ - 3ਆਟੋਮੇਸ਼ਨ
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4ਪ੍ਰਸਾਰਣ
/v1/campaigns, ਆਡੀਅੰਸ, ਸਮੱਗਰੀ ਬਣਾਉਣਾ, ਸਮਾਂ-ਸੂਚੀ ਅਤੇ ਭੇਜਣਾ ਵੱਖਰੇ ਕਦਮਾਂ ਵਜੋਂ - 5ਘਟਨਾਵਾਂ ਅੰਦਰ
/v1/events— ਤੁਹਾਡੀ ਆਪਣੀ ਐਪਲੀਕੇਸ਼ਨ ਦੀਆਂ ਘਟਨਾਵਾਂ, ਟ੍ਰਿੱਗਰ ਵਜੋਂ - 6ਡਿਲੀਵਰੀ
/sender-identities·/domains·/apps·/webhooks - 7ਅੰਕੜੇ
/v1/reports/*, ਅਤੇ ਟ੍ਰੈਕਿੰਗ ਹੋਸਟ 'ਤੇ/track/*
/docs 'ਤੇ OpenAPIਉਸੇ ਪ੍ਰਕਿਰਿਆ 'ਤੇ /mcp
ਰਿਵਾਇਤਾਂ
ਹਰ ਹੋਰ castomo ਸੇਵਾ ਵਾਂਗ ਉਹੀ ਢਾਂਚਾ
ਜੋ ਆਵਾਜ਼ ਤੋਂ ਵੱਧ ਮਹੱਤਵਪੂਰਨ ਹੈ। ਜੇ ਤੁਸੀਂ ਪਹਿਲਾਂ ਹੀ ਇਨ੍ਹਾਂ ਵਿੱਚੋਂ ਇੱਕ ਨੂੰ ਕਾਲ ਕਰਦੇ ਹੋ, ਤਾਂ ਤੁਸੀਂ ਪਹਿਲਾਂ ਹੀ ਜਾਣਦੇ ਹੋ ਕਿ ਇਹ ਕਿਵੇਂ ਜਵਾਬ ਦਿੰਦੀ ਹੈ, ਫੇਲ੍ਹ ਹੁੰਦੀ ਹੈ ਅਤੇ ਪੰਨਾ-ਬੰਦੀ ਕਰਦੀ ਹੈ।
ਇੱਕ ਗ਼ਲਤੀ ਲਿਫ਼ਾਫ਼ਾ
ਹਰ ਫੇਲ੍ਹ ਹੋਣ ਦਾ ਇੱਕੋ ਰੂਪ ਹੁੰਦਾ ਹੈ, ਇੱਕ ਸਥਿਰ ਕੋਡ ਅਤੇ ਇੱਕ ਸੁਨੇਹਾ ਜੋ ਇਨਸਾਨ ਲਈ ਹੈ। ਕੋਈ ਰੂਟ ਨਾਰਾਜ਼ਗੀ ਦਾ ਆਪਣਾ ਢੰਗ ਨਹੀਂ ਘੜਦਾ।
ਕਰਸਰ ਪੰਨਾ-ਬੰਦੀ
ਆਫ਼ਸੈੱਟ ਨਹੀਂ। ਉਹ ਸੂਚੀ ਜੋ ਤੁਹਾਡੇ ਉਸ ਵਿੱਚੋਂ ਲੰਘਦੇ ਸਮੇਂ ਬਦਲਦੀ ਹੈ, ਚੁੱਪਚਾਪ ਕੋਈ ਕਤਾਰ ਨਹੀਂ ਛੱਡਦੀ ਜਾਂ ਦੁਹਰਾਉਂਦੀ — ਜੋ ਆਫ਼ਸੈੱਟ ਪੰਨਾ-ਬੰਦੀ ਚੁੱਪਚਾਪ ਅਤੇ ਲਗਾਤਾਰ ਕਰਦੀ ਹੈ।
ਇਡੈਂਪੋਟੈਂਸੀ ਕੁੰਜੀਆਂ
ਹਰ ਬਦਲਾਅ ਕਰਨ ਵਾਲੇ ਰੂਟ 'ਤੇ। ਕੋਈ ਬੇਨਤੀ ਜਿਸ ਬਾਰੇ ਤੁਹਾਨੂੰ ਯਕੀਨ ਨਾ ਹੋਵੇ ਕਿ ਉਹ ਪਹੁੰਚੀ, ਦੁਬਾਰਾ ਭੇਜੋ ਅਤੇ ਉਹੀ ਜਵਾਬ ਪਾਓ, ਨਾ ਕਿ ਇੱਕ ਹੋਰ ਸੰਪਰਕ, ਇੱਕ ਹੋਰ ਮੁਹਿੰਮ ਜਾਂ ਇੱਕ ਹੋਰ ਭੇਜਣਾ।
ਪ੍ਰੋਜੈਕਟ ਤੱਕ ਸੀਮਿਤ
ਇੱਕ ਟੋਕਨ ਇੱਕ ਟੈਨੈਂਟ ਅਤੇ ਇੱਕ ਪ੍ਰੋਜੈਕਟ, ਦੋਵਾਂ ਨੂੰ ਸੰਬੋਧਿਤ ਕਰਦਾ ਹੈ। ਕਤਾਰ-ਪੱਧਰੀ ਸੁਰੱਖਿਆ ਡਾਟਾਬੇਸ ਵਿੱਚ ਹੀ ਲਾਗੂ ਹੁੰਦੀ ਹੈ, ਕਿਸੇ ਸ਼ਰਤ ਜੋੜਨਾ ਯਾਦ ਰੱਖਣ ਦੀ ਬਜਾਏ।
ਵੈੱਬਹੁੱਕ ਬਾਹਰ
ਦਸਤਖ਼ਤ ਕੀਤੇ ਹੋਏ, ਬੈਕਆੱਫ਼ ਨਾਲ ਦੁਬਾਰਾ ਭੇਜੇ ਜਾਂਦੇ ਹੋਏ, ਅਤੇ ਘੱਟੋ-ਘੱਟ ਇੱਕ ਵਾਰ ਡਿਲੀਵਰ ਹੁੰਦੇ ਹੋਏ — ਇਸ ਲਈ ਤੁਹਾਡਾ ਐਂਡਪੁਆਇੰਟ ਵੀ ਇਡੈਂਪੋਟੈਂਟ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ। ਘਟਨਾਵਾਂ ਉਹੀ ਸ਼ਬਦਾਵਲੀ ਵਰਤਦੀਆਂ ਹਨ ਜੋ ਰਿਪੋਰਟਾਂ ਵਰਤਦੀਆਂ ਹਨ।
ਮਿਟਾਉਣਾ ਅਤੇ ਨਿਰਯਾਤ
ਇੱਕ ਸੰਪਰਕ API ਰਾਹੀਂ ਨਿਰਯਾਤ ਜਾਂ ਮਿਟਾਇਆ ਜਾ ਸਕਦਾ ਹੈ, ਅਤੇ ਮਿਟਾਉਣਾ ਹਰ ਉਸ ਸਹਿਯੋਗੀ ਸੇਵਾ ਤੱਕ ਪਹੁੰਚਦਾ ਹੈ ਜਿਸ ਕੋਲ ਪਰਿਵਾਰ ਦੀ ਆਪਣੀ ਅੰਦਰੂਨੀ ਲੇਨ ਰਾਹੀਂ ਕਾਪੀ ਸੀ।
ਇੰਟਰਫੇਸ ਜੋ ਕੁਝ ਵੀ ਕਰ ਸਕਦਾ ਹੈ, ਇੱਕ POST ਉਹ ਕਰ ਸਕਦਾ ਹੈ।
ਘਟਨਾਵਾਂ ਹੀ ਦਿਲਚਸਪ ਹਿੱਸਾ ਹਨ
ਇਸ ਸਫ਼ੇ ਉੱਤੇ ਬਾਕੀ ਸਭ ਕੁਝ ਉਹ ਪਲੰਬਿੰਗ ਹੈ ਜਿਸਦੀ ਤੁਸੀਂ ਉਮੀਦ ਕਰਦੇ ਹੋ। POST /v1/events ਉਹ ਰੂਟ ਹੈ ਜੋ ਬਦਲਦਾ ਹੈ ਕਿ ਉਤਪਾਦ ਕਿਸ ਲਈ ਹੈ।
ਤੁਹਾਡੀ ਐਪਲੀਕੇਸ਼ਨ ਪਹਿਲਾਂ ਹੀ ਉਹ ਗੱਲਾਂ ਜਾਣਦੀ ਹੈ ਜੋ ਕੋਈ ਮਾਰਕੀਟਿੰਗ ਟੂਲ ਨਹੀਂ ਦੇਖ ਸਕਦਾ: ਕਿਸਨੇ ਆਨਬੋਰਡਿੰਗ ਪੂਰੀ ਕੀਤੀ, ਕਿਸਨੇ ਸਾਥੀ ਨੂੰ ਸੱਦਾ ਭੇਜਿਆ, ਕਿਸਨੇ ਸੀਮਾ ਨੂੰ ਛੂਹਿਆ, ਕਿਸਨੇ ਐਤਵਾਰ ਦੁਪਹਿਰ ਆਪਣਾ ਡਾਟਾ ਨਿਰਯਾਤ ਕੀਤਾ। ਇਹਨਾਂ ਨੂੰ ਆਪਣੇ ਟੋਕਨ ਨਾਲ ਘਟਨਾਵਾਂ ਵਜੋਂ ਭੇਜੋ, ਅਤੇ ਹਰ ਇੱਕ ਟ੍ਰਿੱਗਰ, ਸ਼ਰਤ ਅਤੇ ਸੈਗਮੈਂਟ ਬਣ ਜਾਂਦਾ ਹੈ।
ਬਾਕੀ ਸਭ ਕੁਝ ਸੰਪਰਕ ਮਾਡਲ ਤੋਂ ਨਿਕਲਦਾ ਹੈ। ਘਟਨਾਵਾਂ ਜੋੜੀਆਂ ਜਾਂਦੀਆਂ ਹਨ, ਕਦੇ ਸੋਧੀਆਂ ਨਹੀਂ ਜਾਂਦੀਆਂ; ਉਹ ਉਹ ਲੌਗ ਹਨ ਜਿਸ ਉੱਤੇ ਸਾਰਾ ਉਤਪਾਦ ਟਿਕਿਆ ਹੋਇਆ ਹੈ। ਤੁਹਾਡੀ ਪਰਿਭਾਸ਼ਿਤ ਘਟਨਾ ਉੱਤੇ ਚੱਲਣ ਵਾਲਾ ਫਨਲ ਕੋਈ ਇੰਟੀਗ੍ਰੇਸ਼ਨ ਨਹੀਂ — ਇਹ ਉਹੀ ਢਾਂਚਾ ਹੈ ਜੋ message_opened ਵਰਤਦਾ ਹੈ, ਬੱਸ ਅੰਦਰ ਨਾਮ ਵੱਖਰਾ ਹੈ।
- 1ਤੁਸੀਂ ਇਸਨੂੰ ਭੇਜਦੇ ਹੋ
POST /v1/events— ਇੱਕ ਨਾਮ, ਇੱਕ ਸੰਪਰਕ, ਇੱਕ ਪੇਲੋਡ, ਇੱਕ ਆਈਡੈਂਪੋਟੈਂਸੀ ਕੁੰਜੀ। - 2ਇਹ ਪਹੁੰਚ ਜਾਂਦੀ ਹੈਸੰਪਰਕ ਦੇ ਲੌਗ ਵਿੱਚ ਜੋੜੀ ਜਾਂਦੀ ਹੈ। ਹੋਰ ਕਿਸੇ ਨੂੰ ਇਸਦੇ ਹੋਣ ਦੀ ਲੋੜ ਨਹੀਂ।
- 3ਇੱਕ ਫਨਲ ਸ਼ੁਰੂ ਹੁੰਦਾ ਹੈਕੋਈ ਵੀ ਫਨਲ ਜਿਸਦੀ ਐਂਟਰੀ ਉਸ ਘਟਨਾ ਦਾ ਨਾਮ ਲੈਂਦੀ ਹੈ, ਉਸਦੀ ਐਂਟਰੀ ਸਪੈਕ ਅਧੀਨ ਯੋਗ ਕਿਸੇ ਵੀ ਸੰਪਰਕ ਲਈ।
- 4ਹੋਰ ਫਨਲ ਇਸ ਉੱਤੇ ਸ਼ਾਖਾ ਕਰਦੇ ਹਨ"ਕੀ ਇਹ ਘਟਨਾ ਪਿਛਲੇ 14 ਦਿਨਾਂ ਵਿੱਚ ਵਾਪਰੀ ਹੈ" ਇੱਕ ਸਧਾਰਨ ਸੈਗਮੈਂਟ ਸ਼ਰਤ ਹੈ।
- iਅਤੇ ਇਹ ਚੱਲ ਰਹੀਆਂ ਚੀਜ਼ਾਂ ਖ਼ਤਮ ਕਰਦੀ ਹੈਉਸੇ ਘਟਨਾ ਦਾ ਨਾਮ ਲੈਂਦੀ ਇੱਕ ਲਕੜੀ ਨੋਡ ਉਸ ਵਕਤ ਹੀ ਕ੍ਰਮ ਨੂੰ ਰੋਕ ਦਿੰਦਾ ਹੈ ਜਦੋਂ ਵਿਅਕਤੀ ਉਹ ਕੰਮ ਕਰਦਾ ਹੈ।
ਤੁਹਾਡੀ ਸ਼ਬਦਾਵਲੀਤੁਹਾਡਾ ਟੋਕਨ
ਬਣਾਉਣ ਤੋਂ ਪਹਿਲਾਂ ਜਾਣਨ ਯੋਗ ਹੱਦਾਂ
ClickSomo ਤੁਹਾਡੇ ਬਾਰੇ ਤਿੰਨ ਪਛਾਣਕਰਤਾ ਸਟੋਰ ਕਰਦਾ ਹੈ — ਇੱਕ ਟੈਨੈਂਟ, ਇੱਕ ਪ੍ਰੋਜੈਕਟ ਅਤੇ ਇੱਕ ਯੂਜ਼ਰ, ਅਪਾਰਦਰਸ਼ੀ ਆਈਡੀਆਂ ਵਜੋਂ — ਅਤੇ ਹੋਰ ਕੁਝ ਨਹੀਂ। ਨਾ ਪਾਸਵਰਡ, ਨਾ ਪ੍ਰੋਫਾਈਲ, ਨਾ ਕਾਰਡ, ਨਾ ਬਿੱਲ। ਯੋਜਨਾ ਦੀਆਂ ਹੱਦਾਂ ਅੰਕਾਂ ਵਜੋਂ ਆਉਂਦੀਆਂ ਹਨ: ਕਿੰਨੇ ਸੰਪਰਕ, ਕਿੰਨੀਆਂ ਭੇਜੀਆਂ ਗਈਆਂ, ਕਿੰਨੀਆਂ ਪੀੜ੍ਹੀਆਂ। ਭੁਗਤਾਨ ਦੀ ਸ਼ਬਦਾਵਲੀ ਉਸ ਲਾਈਨ ਨੂੰ ਕਿਸੇ ਵੀ ਦਿਸ਼ਾ ਵਿੱਚ ਪਾਰ ਨਹੀਂ ਕਰਦੀ।
ਤੁਹਾਡੇ ਸੰਪਰਕ ਤੁਹਾਡੇ ਹਨ। ਤੁਸੀਂ ਡਾਟਾ ਕੰਟਰੋਲਰ ਹੋ; ਅਸੀਂ ਪ੍ਰੋਸੈਸਰ ਹਾਂ। ਕੋਈ ਰਾਹ ਨਹੀਂ ਜਿਸ ਰਾਹੀਂ ਪਰਿਵਾਰ ਦਾ ਹੋਰ ਉਤਪਾਦ ਤੁਹਾਡੀ ਸੰਪਰਕ ਸੂਚੀ ਪੜ੍ਹ ਜਾਂ ਲਿਖ ਸਕੇ, ਅਤੇ ਨਾ ਹੀ ਕਿਸੇ ਲਈ ਕੋਈ ਇਨਜੈਸਟ ਲੇਨ ਹੈ।
ਜੇ ਤੁਸੀਂ ਇਸਦਾ ਗੰਭੀਰਤਾ ਨਾਲ ਮੁਲਾਂਕਣ ਕਰ ਰਹੇ ਹੋ: ਇਸ ਵੈੱਬਸਾਈਟ ਦਾ ਹੋਰ ਕੁਝ ਪੜ੍ਹਨ ਤੋਂ ਪਹਿਲਾਂ /docs ਪੜ੍ਹੋ। API ਉਤਪਾਦ ਜੋ ਕਰਦਾ ਹੈ ਉਸਦਾ ਇਮਾਨਦਾਰ ਵੇਰਵਾ ਹੈ, ਅਤੇ ਇਹਨਾਂ ਸਫ਼ਿਆਂ ਉੱਤੇ ਦਿੱਤਾ ਹਰ ਦਾਅਵਾ ਉੱਥੇ ਲੱਭਣਯੋਗ ਕਿਸੇ ਰੂਟ ਜਾਂ ਨੋਡ ਕਿਸਮ ਨਾਲ ਮੇਲ ਖਾਂਦਾ ਹੈ। ਜਦੋਂ ਸਕੀਮਾ ਬਦਲਦਾ ਹੈ, ਇਹ ਸਫ਼ੇ ਬਦਲਦੇ ਹਨ।