ਇਸ ਸੂਚੀ ਬਾਰੇ
ਜਿੱਥੇ ਜ਼ਿਆਦਾਤਰ API ਦਸਤਾਵੇਜ਼ ਗਲਤ ਸਾਬਤ ਹੁੰਦੇ ਹਨ
ਬਹੁਤ ਸਾਰੀਆਂ ਗਾਈਡਾਂ ਐਂਡਪੁਆਇੰਟਾਂ ਦੀ ਸੂਚੀ ਤਾਂ ਦਿੰਦੀਆਂ ਹਨ ਪਰ ਉਹਨਾਂ ਵੇਰਵਿਆਂ ਨੂੰ ਛੱਡ ਦਿੰਦੀਆਂ ਹਨ ਜੋ ਅਸਲ ਵਿੱਚ ਭੰਬਲਭੂਸਾ ਪੈਦਾ ਕਰਦੇ ਹਨ: ਪ੍ਰਮਾਣਿਕਤਾ ਵਿਹਾਰਕ ਤੌਰ 'ਤੇ ਕਿਵੇਂ ਕੰਮ ਕਰਦੀ ਹੈ, ਸਹੀ ਬੇਨਤੀ ਅਤੇ ਜਵਾਬ ਦੀਆਂ ਉਦਾਹਰਨਾਂ, ਅਤੇ ਖਾਸ ਗਲਤੀਆਂ ਦਾ ਕੀ ਅਰਥ ਹੈ ਅਤੇ ਉਹਨਾਂ ਨੂੰ ਕਿਵੇਂ ਹੱਲ ਕਰਨਾ ਹੈ। ਜਦੋਂ ਅਜਿਹਾ ਹੁੰਦਾ ਹੈ, ਤਾਂ ਡਿਵੈਲਪਰਾਂ ਨੂੰ ਸਹਾਇਤਾ ਟਿਕਟਾਂ ਦਰਜ ਕਰਨ ਦਾ ਸਹਾਰਾ ਲੈਣਾ ਪੈਂਦਾ ਹੈ, ਜੋ ਕਿ ਦਸਤਾਵੇਜ਼ ਹੋਣ ਦੇ ਮਕਸਦ ਨੂੰ ਹੀ ਖ਼ਤਮ ਕਰ ਦਿੰਦਾ ਹੈ।
ਸਾਡੀ ਪਹੁੰਚ
ਅਸੀਂ ਧਾਰਨਾਵਾਂ 'ਤੇ ਭਰੋਸਾ ਕਰਨ ਦੀ ਬਜਾਏ ਸਿੱਧੇ ਤੁਹਾਡੇ ਸਰੋਤ ਕੋਡ ਤੋਂ ਨਿਰਮਾਣ ਕਰਦੇ ਹਾਂ। ਅਸੀਂ ਲਾਈਵ ਪ੍ਰਮਾਣ ਪੱਤਰਾਂ ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਖੁਦ API ਦੀ ਜਾਂਚ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਤੁਹਾਡੇ ਰੂਟਾਂ, ਪ੍ਰਮਾਣਿਕਤਾ ਤਰਕ ਅਤੇ ਗਲਤੀ ਪ੍ਰਬੰਧਨ ਦੀ ਜਾਂਚ ਕਰਦੇ ਹਾਂ। ਅੰਤਿਮ ਦਸਤਾਵੇਜ਼ ਵਿਚਲੀ ਹਰੇਕ ਉਦਾਹਰਨ ਸਾਡੇ ਵੱਲੋਂ ਭੇਜੀ ਗਈ ਅਸਲ ਬੇਨਤੀ ਅਤੇ ਪ੍ਰਾਪਤ ਕੀਤੇ ਗਏ ਜਵਾਬ ਨੂੰ ਦਰਸਾਉਂਦੀ ਹੈ, ਜਿਸ ਨਾਲ ਇਹ ਯਕੀਨੀ ਹੁੰਦਾ ਹੈ ਕਿ ਕੋਈ ਵੀ ਮਨਘੜਤ ਵੇਰਵੇ ਜਾਂ ਅਸੰਭਵ ਸਥਿਤੀ ਕੋਡ ਸ਼ਾਮਲ ਨਾ ਹੋਣ।
ਤੁਹਾਨੂੰ ਕੀ ਪ੍ਰਾਪਤ ਹੁੰਦਾ ਹੈ
- ਪ੍ਰਮਾਣਿਕਤਾ ਮਾਰਗਦਰਸ਼ਨ: ਟੋਕਨ ਜਾਰੀ ਕਰਨਾ, ਰਿਫ੍ਰੈਸ਼ ਕਰਨਾ, ਅਤੇ ਜੇਕਰ ਇਹ ਸੈਸ਼ਨ ਦੇ ਵਿਚਕਾਰ ਹੀ ਖਤਮ ਹੋ ਜਾਂਦਾ ਹੈ ਤਾਂ ਕੀ ਹੁੰਦਾ ਹੈ।
- ਹਰੇਕ ਐਂਡਪੁਆਇੰਟ ਦੀ ਪੂਰੀ ਕਵਰੇਜ, ਜਿਸ ਵਿੱਚ ਪੈਰਾਮੀਟਰ, ਇੱਕ ਕੰਮ ਕਰਦੀ ਉਦਾਹਰਨ ਬੇਨਤੀ ਅਤੇ ਅਸਲ ਜਵਾਬ ਸੰਰਚਨਾ ਸ਼ਾਮਲ ਹੈ।
- ਇੱਕ ਗਲਤੀ ਸੰਦਰਭ ਜੋ ਹਰੇਕ ਕੋਡ ਨੂੰ ਉਸਦੇ ਕਾਰਨ ਅਤੇ ਹੱਲ ਨਾਲ ਜੋੜਦਾ ਹੈ, ਨਾ ਕਿ ਸਿਰਫ਼ ਦੁਹਰਾਇਆ ਗਿਆ ਸੁਨੇਹਾ।
- ਇੱਕ ਨਵੇਂ ਡਿਵੈਲਪਰ ਨੂੰ ਸ਼ੁਰੂਆਤ ਤੋਂ ਇੱਕ ਸਫਲ ਕਾਲ ਤੱਕ ਲੈ ਜਾਣ ਲਈ ਤਿਆਰ ਕੀਤਾ ਗਿਆ ਇੱਕ ਤੇਜ਼-ਸ਼ੁਰੂਆਤ ਮਾਰਗ।
- ਜਿੱਥੇ ਵੀ ਢੁਕਵਾਂ ਹੋਵੇ, ਦਰ ਸੀਮਾਵਾਂ, ਪੰਨਾਬੰਦੀ (pagination), ਵੈੱਬਹੁੱਕ ਅਤੇ ਆਈਡੈਂਪੋਟੈਂਸੀ 'ਤੇ ਨੋਟਸ।
ਸਪੁਰਦਗੀ ਫਾਰਮੈਟ
ਅਸੀਂ ਤੁਹਾਡੀ ਰਿਪੋਜ਼ਟਰੀ ਦੇ ਅਨੁਕੂਲ ਮਾਰਕਡਾਊਨ ਪ੍ਰਦਾਨ ਕਰਦੇ ਹਾਂ, ਜਿਸ ਨੂੰ ਇਸ ਤਰ੍ਹਾਂ ਸੰਰਚਿਤ ਕੀਤਾ ਜਾਂਦਾ ਹੈ ਤਾਂ ਜੋ ਇਹ OpenAPI ਜਾਂ ਕਿਸੇ ਦਸਤਾਵੇਜ਼ੀ ਸਾਈਟ ਵਿੱਚ ਫਿੱਟ ਹੋ ਸਕੇ, ਜਿਸ ਨੂੰ ਵੀ ਤੁਹਾਡੀ ਟੀਮ ਅੱਪਡੇਟ ਰੱਖੇਗੀ। ਕੋਡ ਦੇ ਨਮੂਨੇ ਉਹਨਾਂ ਭਾਸ਼ਾਵਾਂ ਵਿੱਚ ਪ੍ਰਦਾਨ ਕੀਤੇ ਜਾਂਦੇ ਹਨ ਜਿਨ੍ਹਾਂ 'ਤੇ ਤੁਹਾਡੇ ਉਪਭੋਗਤਾ ਭਰੋਸਾ ਕਰਦੇ ਹਨ ਅਤੇ ਉਹਨਾਂ ਨੂੰ ਚਲਾ ਕੇ ਜਾਂਚਿਆ ਜਾਂਦਾ ਹੈ। ਬੇਨਤੀ ਕਰਨ 'ਤੇ ਇੱਕ Postman-ਸ਼ੈਲੀ ਦਾ ਸੰਗ੍ਰਹਿ ਸ਼ਾਮਲ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ।
ਸਾਨੂੰ ਤੁਹਾਡੇ ਵੱਲੋਂ ਕੀ ਚਾਹੀਦਾ ਹੈ
ਤੁਹਾਡੀ ਰਿਪੋਜ਼ਟਰੀ ਜਾਂ OpenAPI ਫ਼ਾਈਲ ਤੱਕ ਪਹੁੰਚ, ਇੱਕ ਜਾਂਚ ਵਾਤਾਵਰਨ ਲਈ ਕਾਰਜਸ਼ੀਲ ਪ੍ਰਮਾਣ ਪੱਤਰ, ਅਤੇ ਉਹ ਸਵਾਲ ਜਿਨ੍ਹਾਂ ਦੇ ਜਵਾਬ ਤੁਹਾਡੇ ਸਹਾਇਤਾ ਕਰਮਚਾਰੀ ਸਭ ਤੋਂ ਵੱਧ ਦਿੰਦੇ ਹਨ - ਇਹ ਗਾਈਡ ਦੀ ਬਣਤਰ ਨੂੰ ਤਿਆਰ ਕਰਦੇ ਹਨ।
ਕੀ ਸ਼ਾਮਲ ਨਹੀਂ ਹੈ
ਇਹ ਸੇਵਾ ਸਾਫਟਵੇਅਰ ਦੇ ਵਿਹਾਰ ਦੇ ਸਹੀ ਤਕਨੀਕੀ ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਕਵਰ ਕਰਦੀ ਹੈ; ਪ੍ਰਚਾਰ ਜਾਂ ਮਾਰਕੀਟਿੰਗ ਸਮੱਗਰੀ ਇੱਕ ਵੱਖਰਾ ਕੰਮ ਹੈ।
ਪ੍ਰਕਿਰਿਆ ਅਤੇ ਸਮਾਂ
ਤੁਹਾਨੂੰ ਇੱਕ ਮੁਕੰਮਲ ਪਹਿਲਾ ਖਰੜਾ ਪ੍ਰਾਪਤ ਹੋਵੇਗਾ, ਜਿਸਦੀ ਤੁਸੀਂ ਆਪਣੀ ਸਹਾਇਤਾ ਟੀਮ ਦੇ ਸਾਹਮਣੇ ਆਉਣ ਵਾਲੇ ਵਾਰ-ਵਾਰ ਪੁੱਛੇ ਜਾਣ ਵਾਲੇ ਸਵਾਲਾਂ ਨਾਲ ਜਾਂਚ ਕਰ ਸਕਦੇ ਹੋ। ਅਸੀਂ ਕਿਸੇ ਸ਼ਾਨਦਾਰ ਪਰ ਗਲਤ ਚੀਜ਼ ਨੂੰ ਸੌਂਪਣ ਦੀ ਬਜਾਏ ਕਿਸੇ ਇੰਜੀਨੀਅਰ ਵੱਲੋਂ ਸ਼ੁਰੂਆਤ ਵਿੱਚ ਹੀ ਕਿਸੇ ਔਖੀ ਸਥਿਤੀ (edge case) ਦੀ ਨਿਸ਼ਾਨਦੇਹੀ ਕਰਵਾਉਣਾ ਬਿਹਤਰ ਸਮਝਾਂਗੇ। ਕਿਉਂਕਿ ਹਰੇਕ ਉਦਾਹਰਨ ਨੂੰ ਤੁਹਾਡੇ ਲਾਈਵ API ਵਿਰੁੱਧ ਚਲਾਇਆ ਗਿਆ ਹੈ, ਇਸ ਲਈ ਅੰਤਿਮ ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਕੁਝ ਵੀ ਸਿਧਾਂਤਕ ਨਹੀਂ ਹੈ।
ਇਹ ਪੈਕੇਜ 500.99 USD ਅਤੇ 10 ਦਿਨਾਂ ਦੇ ਸਮੇਂ ਵਿੱਚ, ਸੋਧ ਦੇ ਇੱਕ ਗੇੜ ਦੇ ਨਾਲ, ਇੱਕ ਹੀ ਵਾਰ ਵਿੱਚ ਪ੍ਰਦਾਨ ਕੀਤੇ ਜਾਣ ਵਾਲੇ ਇੱਕ ਨਿਸ਼ਚਿਤ-ਕੀਮਤ API ਦਸਤਾਵੇਜ਼ ਦੇ ਦਾਇਰੇ ਨੂੰ ਕਵਰ ਕਰਦਾ ਹੈ। ਤੁਹਾਨੂੰ ਉਹ ਡੋਮੇਨ ਪ੍ਰਦਾਨ ਕਰਨ ਦੀ ਲੋੜ ਹੋਵੇਗੀ ਜਿਸ ਨਾਲ ਆਰਡਰ ਸੰਬੰਧਿਤ ਹੈ ਅਤੇ ਆਪਣਾ ਸੰਖੇਪ ਵੇਰਵਾ ਦੇਣਾ ਹੋਵੇਗਾ।