PeekHire లోగో
ఆటోమేషన్ & డెవలపర్లు

API కీలు

API యాక్సెస్‌ను ధృవీకరించే కీలను సృష్టించండి, వాటి పరిధిని సెట్ చేయండి, మారుస్తూ ఉండండి.

API కీలు PeekHireకు ప్రోగ్రామాటిక్ యాక్సెస్‌ను ధృవీకరిస్తాయి — REST APIతో పాటు మీ నో-కోడ్ ఆటోమేషన్లకు కూడా.

కీని సృష్టించడం

  1. డెవలపర్ టూల్స్ → API కీలు → సృష్టించండికి వెళ్లండి.
  2. కీ దేనికి ఉపయోగిస్తారో గుర్తుంచుకోవడానికి, దానికి స్పష్టమైన పేరు పెట్టండి (ఉదా. Zapier ఇంటిగ్రేషన్).
  3. కీ విలువ చూపించినప్పుడు దాన్ని కాపీ చేయండి — భద్రత కోసం, ఆ తర్వాత దాన్ని మళ్లీ చూడలేరు.

కీని ఉపయోగించడం

ప్రతి అభ్యర్థనలో కీని బేరర్ టోకెన్‌గా పంపండి:

curl https://your-api-host/api/v1/applications \
  -H "Authorization: Bearer YOUR_API_KEY"

అనుమతులు

ప్రతి కీకి, అది ఏం చేయగలదో పరిమితం చేసే అనుమతులు ఉంటాయి:

  • చదవడం — డేటాను పొందడం (క్యాంపెయిన్లు, దరఖాస్తులు, వినియోగదారుల జాబితాను చూడడం, వివరాలను పొందడం).
  • రాయడం — డేటాను సృష్టించడం లేదా మార్చడం.

ఇంటిగ్రేషన్‌కు అవసరమైన అనుమతులనే ఇవ్వండి (కనీస అనుమతుల సూత్రం). స్ప్రెడ్‌షీట్ లేదా డ్యాష్‌బోర్డ్‌లోకి డేటాను సింక్ చేయడానికి చదవడానికి మాత్రమే అనుమతించే కీ సరిపోతుంది; PeekHireలో ఏదైనా మార్చాల్సి వచ్చినప్పుడే రాయడం అనుమతిని జోడించండి.

కీలను సురక్షితంగా ఉంచడం

  • కీలను పాస్‌వర్డ్‌లలా పరిగణించండి. కీ ఉన్న ఎవరైనా మీ డేటాపై చర్యలు తీసుకోగలరు.
  • కీలను ఎప్పుడూ రిపాజిటరీలో కమిట్ చేయకండి లేదా క్లయింట్-సైడ్ కోడ్‌లో పెట్టకండి.
  • ప్రతి ఇంటిగ్రేషన్‌కు ప్రత్యేక కీని ఉపయోగించండి, అప్పుడు ఇతర వాటిపై ప్రభావం లేకుండా ఒక కీని రద్దు చేయవచ్చు.
  • కీలను సీక్రెట్స్ మేనేజర్‌లో లేదా మీ టూల్ క్రెడెన్షియల్ స్టోర్‌లో భద్రపరచండి; సాధారణ టెక్స్ట్‌లో ఉంచకండి.

కీలను మార్చడం, రద్దు చేయడం

ఒక కీ బయటపడితే — లేదా మీరు నిర్ణీత షెడ్యూల్ ప్రకారం కీలను మారుస్తుంటే — కొత్త కీని సృష్టించి, మీ ఇంటిగ్రేషన్‌ను అప్‌డేట్ చేసి, ఆ తర్వాత పాత కీని తొలగించండి. కీని తొలగిస్తే దాని యాక్సెస్ వెంటనే రద్దవుతుంది.